Skip to content

Commit 228927d

Browse files
Merge pull request #29 from RQM-Technologies-dev/codex/produce-baseline-documentation-brief
Add Company & Product Map page and update site navigation
2 parents ec6da69 + 83c7620 commit 228927d

3 files changed

Lines changed: 83 additions & 0 deletions

File tree

docs/company-overview.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Company and Product Map
2+
3+
RQM Technologies develops software and API-first capabilities for quantum workflow engineering, with theory-informed methods grounded in quaternionic and SU(2) geometry.
4+
5+
This documentation site focuses on **what is currently documented for production or beta integration**, while keeping research and planned interfaces clearly labeled.
6+
7+
---
8+
9+
## How the pieces relate
10+
11+
```text
12+
RQM Technologies (company)
13+
├─ RQM Platform (documentation and integration surface)
14+
│ ├─ rqm-api (service boundary)
15+
│ ├─ rqm-circuits (public circuit boundary)
16+
│ ├─ rqm-compiler (internal optimization engine)
17+
│ ├─ execution bridges (qiskit / braket / pennylane)
18+
│ └─ rqm-studio (workflow product layer)
19+
└─ Research streams (theory notes, drafts, and planned interfaces)
20+
```
21+
22+
---
23+
24+
## Product and platform roles
25+
26+
| Layer / Product | Current role in this docs site | Audience |
27+
|---|---|---|
28+
| **RQM Technologies** | Company umbrella for platform, product, and research efforts | Partners, evaluators, contributors |
29+
| **RQM Platform** | Core integration model and boundary architecture | Developers, coding agents |
30+
| **RQM Studio** | Browser workflow layer built on API services | Product users and workflow builders |
31+
| **rqm-api** | Public service boundary for validate/analyze/optimize/execution and account-linked flows | Integrators, backend/app developers |
32+
| **rqm-circuits** | Canonical public circuit schema and interchange boundary | SDK and API consumers |
33+
| **rqm-compiler** | Internal optimization/canonicalization engine (`u1q` internal) | Compiler engineers |
34+
| **Execution bridges** | Provider-specific lowering/routing surfaces | Teams integrating Qiskit, Braket, PennyLane |
35+
| **Theory / research notes** | Conceptual grounding and in-progress research narrative | Researchers and technical evaluators |
36+
37+
---
38+
39+
## Documentation status model
40+
41+
Use this model to interpret claims consistently:
42+
43+
- **Production**: documented behavior intended for current integration.
44+
- **Beta**: documented, capability-gated behavior requiring explicit checks.
45+
- **Research**: conceptual or draft material; not a runtime contract.
46+
- **Planned/Proposed**: future-facing documentation, not available capability.
47+
48+
If a page discusses research or planned material, treat it as non-contractual unless a production API surface explicitly documents availability.
49+
50+
---
51+
52+
## Where to start
53+
54+
- New to the platform: [Platform Overview](platform/overview.md)
55+
- Building integrations: [Getting Started / Quickstart](getting-started/quickstart.md)
56+
- Implementing with an agent: [Agent Portal](agents/index.md)
57+
- Evaluating trust and claims posture: [Verification / Trust](products/verification-trust.md)
58+
- Reading conceptual background: [Concepts](concepts/quaternion-intuition.md)
59+
- Reading current draft research: [QCE 2026 paper draft](research/qce2026-u1q-paper.md)

docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Agent-ready quantum software documentation for circuit validation, optimization,
1111
[:material-robot-outline: Connect an Agent](agents/index.md){ .md-button .md-button--primary }
1212
[:material-file-document-outline: Read llms.txt](llms.txt){ .md-button }
1313
[:material-api: API Overview](api/overview.md){ .md-button }
14+
[:material-domain: Company + Product Map](company-overview.md){ .md-button }
1415
[:material-rocket-launch: Quickstart](getting-started/quickstart.md){ .md-button }
1516

1617
</div>
@@ -80,3 +81,12 @@ Use trust and verification pages to understand proof-gated and fail-closed behav
8081
| Research Assistant | [QCE 2026 paper draft](research/qce2026-u1q-paper.md) and [SU(2) geometry](concepts/su2-geometry.md) |
8182

8283
</div>
84+
85+
86+
## Documentation posture
87+
88+
This site separates production, beta, research, and planned material so integrations stay grounded in documented behavior.
89+
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.

mkdocs.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ extra_css:
6060

6161
nav:
6262
- Home: index.md
63+
- Company & Product Map: company-overview.md
6364
- Agent Connect:
6465
- Agent Portal: agents/index.md
6566
- Prompt Pack: agents/prompts.md
@@ -107,3 +108,16 @@ nav:
107108
- Canonical IR (u1q): compiler/canonical-ir.md
108109
- Research:
109110
- QCE 2026 paper draft: research/qce2026-u1q-paper.md
111+
- Legacy & Archive:
112+
- Legacy Architecture Redirect: architecture.md
113+
- Legacy Ecosystem Redirect: ecosystem.md
114+
- Legacy Concepts Redirect: concepts.md
115+
- Legacy Optimization Redirect: optimization.md
116+
- Legacy Quickstart Redirect: quickstart.md
117+
- Legacy API Quickstart Redirect: api/quickstart.md
118+
- Notebooks and Learning Path: notebooks.md
119+
- Backends (Legacy API page): api/backends.md
120+
- Coupling Analysis (Legacy API page): api/coupling-analysis.md
121+
- Execution Capabilities (Legacy API page): api/execution-capabilities.md
122+
- Precision Timing (Coming Soon): precision-timing/index.md
123+
- Quantum Communication (Coming Soon): quantum-communication/index.md

0 commit comments

Comments
 (0)