Skip to content

Commit 04f393a

Browse files
Merge pull request #30 from RQM-Technologies-dev/codex/redesign-documentation-homepage-for-user-accessibility
Redesign homepage around 1–5 user-door entry model
2 parents 228927d + 008edcd commit 04f393a

1 file changed

Lines changed: 69 additions & 32 deletions

File tree

docs/index.md

Lines changed: 69 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,64 +4,102 @@
44

55
# RQM Platform
66

7-
Agent-ready quantum software documentation for circuit validation, optimization, execution routing, and geometry-native analysis.
7+
Agent-ready quantum software for validating, optimizing, and routing quantum circuits through geometry-native tooling.
8+
9+
**Do not learn the whole theory first. Enter through the problem you already have.**
810

911
<div class="rqm-button-row" markdown="1">
1012

13+
[:material-tune-variant: Optimize a Circuit](products/optimization-api.md){ .md-button .md-button--primary }
1114
[:material-robot-outline: Connect an Agent](agents/index.md){ .md-button .md-button--primary }
12-
[:material-file-document-outline: Read llms.txt](llms.txt){ .md-button }
1315
[:material-api: API Overview](api/overview.md){ .md-button }
14-
[:material-domain: Company + Product Map](company-overview.md){ .md-button }
1516
[:material-rocket-launch: Quickstart](getting-started/quickstart.md){ .md-button }
17+
[:material-domain: Company + Product Map](company-overview.md){ .md-button }
18+
[:material-file-document-outline: Read llms.txt](llms.txt){ .md-button }
1619

1720
</div>
1821

1922
</div>
2023

21-
## Built for agents and developers
22-
23-
RQM keeps the public integration boundary explicit while giving developers and coding agents clear paths to validate circuits, run optimization workflows, and route execution through documented bridges.
24+
## What are you trying to improve?
2425

2526
<div class="rqm-cols-3" markdown="1">
2627

2728
<div class="rqm-card" markdown="1">
2829

29-
<h3>Agent Connect</h3>
30+
<h3>1) I optimize quantum circuits</h3>
31+
32+
Circuits are too large, too deep, or hard to reason about. Start by validating circuits, running optimization, and comparing before/after metrics such as gate count and depth where supported.
33+
34+
- [Optimization API](products/optimization-api.md)
35+
- [Quickstart](getting-started/quickstart.md)
36+
- [API Overview](api/overview.md)
37+
- [Optimization Engine](platform/optimization-engine.md)
38+
39+
</div>
40+
41+
<div class="rqm-card" markdown="1">
42+
43+
<h3>2) I build with Qiskit, Braket, PennyLane, or other SDKs</h3>
44+
45+
Use RQM as a geometry-native optimization and routing layer around your existing SDK workflow instead of replacing your stack.
46+
47+
- [Execution Bridges](platform/execution-bridges.md)
48+
- [Execution Workflows](products/execution-workflows.md)
49+
- [SDK Local Setup](getting-started/sdk-local-setup.md)
50+
- [Execution API](api/execution.md)
51+
52+
</div>
53+
54+
<div class="rqm-card" markdown="1">
55+
56+
<h3>3) I am building with agents</h3>
3057

31-
Start with machine-readable docs and implementation guidance for coding assistants.
58+
Use machine-readable docs, prompts, contract tests, and recipes that AI coding assistants can execute against.
3259

3360
- [Agent Portal](agents/index.md)
3461
- [Prompt Pack](agents/prompts.md)
3562
- [Contract Tests](agents/contract-tests.md)
63+
- [Agent Recipes](agents/recipes/index.md)
64+
- [llms.txt](llms.txt)
3665

3766
</div>
3867

3968
<div class="rqm-card" markdown="1">
4069

41-
<h3>API + Circuit Boundary</h3>
70+
<h3>4) I evaluate, fund, or partner with advanced technology</h3>
4271

43-
Build against the documented API and canonical public circuit schema.
72+
See what is production, what is measured, and what remains research. Start from architecture and verification/trust boundaries.
4473

45-
- [API Overview](api/overview.md)
46-
- [Canonical Circuit Boundary](platform/canonical-circuit-boundary.md)
47-
- [Optimization API](products/optimization-api.md)
74+
- [Company + Product Map](company-overview.md)
75+
- [Platform Architecture](platform/architecture.md)
76+
- [Verification / Trust](products/verification-trust.md)
77+
- [Production vs Research Boundary](agents/recipes/research-boundary.md)
4878

4979
</div>
5080

5181
<div class="rqm-card" markdown="1">
5282

53-
<h3>Verification + Trust</h3>
83+
<h3>5) I want the theory</h3>
5484

55-
Use trust and verification pages to understand proof-gated and fail-closed behavior.
85+
Explore quaternionic/SU(2)/spinor geometry after choosing a practical entry path. Theory and research are non-contractual unless shipped in documented APIs.
5686

57-
- [Verification / Trust](products/verification-trust.md)
58-
- [Production vs Research Boundary](agents/recipes/research-boundary.md)
59-
- [Platform Architecture](platform/architecture.md)
87+
- [Quaternion Intuition](concepts/quaternion-intuition.md)
88+
- [Spinor-Bloch Mapping](concepts/spinor-bloch.md)
89+
- [SU(2) Geometry](concepts/su2-geometry.md)
90+
- [Global Phase](concepts/global-phase.md)
91+
- [QCE 2026 paper draft](research/qce2026-u1q-paper.md)
6092

6193
</div>
6294

6395
</div>
6496

97+
## The RQM connection model
98+
99+
RQM should be easy to enter from different user contexts. Quantum developers, SDK users, agents, evaluators, and researchers should not all be forced through the same front door.
100+
101+
This homepage is organized around practical connection points first: validate, optimize, integrate, and verify. Theory remains available, but downstream from implementation paths.
102+
65103
## Architecture flow
66104

67105
<div class="rqm-flow" markdown="1">
@@ -72,21 +110,20 @@ Use trust and verification pages to understand proof-gated and fail-closed behav
72110

73111
## Start by role
74112

75-
| Role | Start here |
76-
|---|---|
77-
| Coding Agent | [Agent Portal](agents/index.md), [llms.txt](llms.txt), and [Contract Tests](agents/contract-tests.md) |
78-
| Developer | [Quickstart](getting-started/quickstart.md) and [API Overview](api/overview.md) |
79-
| Studio Builder | [RQM Studio](products/rqm-studio.md) and [Execution Workflows](products/execution-workflows.md) |
80-
| Evaluator / Partner | [Platform Architecture](platform/architecture.md) and [Verification / Trust](products/verification-trust.md) |
81-
| Research Assistant | [QCE 2026 paper draft](research/qce2026-u1q-paper.md) and [SU(2) geometry](concepts/su2-geometry.md) |
82-
83-
</div>
84-
113+
| Role | Recommended first door | Start here |
114+
|---|---|---|
115+
| Quantum Developer | 1) Optimize circuits | [Optimization API](products/optimization-api.md), [Quickstart](getting-started/quickstart.md), [Optimization Engine](platform/optimization-engine.md) |
116+
| SDK Integrator | 2) Build with existing SDKs | [Execution Bridges](platform/execution-bridges.md), [Execution Workflows](products/execution-workflows.md), [Execution API](api/execution.md) |
117+
| Coding Agent Builder | 3) Build with agents | [Agent Portal](agents/index.md), [llms.txt](llms.txt), [Contract Tests](agents/contract-tests.md) |
118+
| Evaluator / Partner | 4) Evaluate or partner | [Company + Product Map](company-overview.md), [Platform Architecture](platform/architecture.md), [Verification / Trust](products/verification-trust.md) |
119+
| Researcher | 5) Understand theory | [Quaternion Intuition](concepts/quaternion-intuition.md), [SU(2) Geometry](concepts/su2-geometry.md), [QCE 2026 paper draft](research/qce2026-u1q-paper.md) |
85120

86121
## Documentation posture
87122

88-
This site separates production, beta, research, and planned material so integrations stay grounded in documented behavior.
123+
Use documentation by maturity level:
89124

90-
- Production and beta: use for implementation with route/schema checks.
91-
- Research and planned: treat as non-contractual unless shipped in documented API surfaces.
92-
- Start with [Company + Product Map](company-overview.md) for entity/layer relationships.
125+
- **Production/Beta pages:** implementation surfaces for real integrations, with documented API and boundary behavior.
126+
- **Research/Planned pages:** non-contractual references unless and until behavior is shipped in documented API surfaces.
127+
- **When in doubt:** confirm scope via [Company + Product Map](company-overview.md) and API/product pages tied to your selected door.
128+
129+
</div>

0 commit comments

Comments
 (0)