Documentation
Implementation Inventory
Project-Agent / docs/IMPLEMENTATION_INVENTORY.md
This inventory maps the documentation set to the implementation that exists in this repository. It is intentionally factual: use it to decide whether a product area is already documented, documented only at the narrative level, or missing implementation-level coverage.
Repository Role
Project-Agent is the original ARX monorepo. It contains product application code, public site content, reference-agent manifests, Atlas services, benchmark/demo surfaces, SDKs, connector implementations, deployment material, and long-form product documentation.
The extracted repos now own cleaner public boundaries:
arxsec-appowns the app product runtime.arxsec-siteowns the public website and public docs.arx-ecosystemowns public ecosystem/reference-agent material.arx-mcp-serverowns the standalone MCP package.
This repo remains useful as the broad source corpus and historical integration workspace.
Built Surfaces
| Surface | Implementation | Current Documentation | Coverage | |---|---|---|---| | FastAPI control plane | arxsec-api/main.py, arxsec-api/app/api/, arxsec-api/app/services/ | docs/api/, arxsec-api/docs/, arxsec-api/docs/API_KEYS.md | Partial. Core APIs are documented, but many router groups are not mapped one-to-one. | | Frontend dashboard | arxsec-api/frontend/src/app/, arxsec-api/frontend/src/components/ | arxsec-api/frontend/README.md, arxsec-api/frontend/docs/ | Partial. Shell and smoke docs exist; page-level product docs are incomplete. | | Connectors | arxsec-api/app/connectors/, connectors/, docs/connectors/ | docs/connectors/, docs/sdk/using-connectors.md | Partial. Category docs exist, but the code has more connector modules than the public catalog explains individually. | | Governance and audit | arxsec-api/app/api/v1/policies.py, approvals.py, audit.py, governance.py, drift.py | docs/governance/, docs/compliance/, docs/security/ | Strong narrative coverage, moderate implementation coverage. | | Workforce/objective runtime | arxsec-api/app/api/v1/workforce*.py, objectives.py, lifecycle.py, catalog.py, hiring_requests.py | docs/getting-started/, docs/sdk/, reference-agents/ | Partial. Product concept is documented; exact API/page inventory needs more detail. | | Reference agents | reference-agents/ | reference-agents/INDEX.md, reference-agents/MANIFEST_FRAMEWORK.md, per-agent READMEs | Strong. This is one of the best-covered surfaces. | | Atlas | atlas/, atlas-architect/, docs/atlas/ | docs/atlas/atlas-spec.md, docs/atlas/advisor-enterprise-controls.md | Moderate. Specs exist; service/runbook ownership is scattered. | | SDKs | arxsec-api/sdk/, sdks/, docs/sdk/ | docs/sdk/, SDK READMEs | Moderate. Builder path exists, but source-of-truth split is unclear. | | Deployment and operations | arxsec-api/deploy/, arxsec-api/supabase/, atlas/charts/, docs/ops/, docs/deployment/ | docs/deployment-guide.md, docs/deployment/72-hour-runbook.md, docs/ops/ | Good for runbooks, incomplete for repo-specific ownership. | | Public website/content | blog/, docs-pages/, compliance/, connectors/, governance/ | docs/, README.md | Duplicated with arxsec-site; treat arxsec-site as the cleaner public owner. |
Implementation Signals
- API router registrations: about 66
include_routercalls. - Frontend app pages: about 124
page.tsxroutes. - Docs pages under
docs/: about 172 Markdown files. - Reference-agent directories: about 190.
- Connector source files under
arxsec-api/app/connectors/: about 165 Python files.
These counts are orientation markers, not release guarantees.
Canonical Reading Order
README.mdfor the broad product and repo story.docs/REPO_BOUNDARIES.mdfor the monorepo's current role.docs/MONOREPO_STATUS.mdfor historical/staging classification.docs/index.mdfor buyer, operator, and builder paths.docs/SUMMARY.mdfor the docs table of contents.reference-agents/INDEX.mdfor the agent matrix.arxsec-api/frontend/docs/dashboard-shell-contract.mdfor dashboard shell expectations.arxsec-api/docs/for app-specific integration and runtime docs.
Known Organization Gaps
- The docs describe ARX well, but they do not yet provide a generated API-router-to-doc map.
- Frontend dashboard surfaces are numerous and not represented by a page inventory.
- Connector documentation is organized by category; not every implemented connector has a matching public reference page.
Project-Agent,Project-Agent-trust-merge, andarxsec-siteduplicate large sections of docs.- Archived status reports remain in the main docs tree and can distract from current operating docs.
- Some docs link to paths that only exist in sibling repos or historical layouts.
For the app-level completion maps, use the extracted arxsec-app docs:
arxsec-app/docs/API_SURFACE.mdarxsec-app/frontend/docs/DASHBOARD_SURFACE.mdarxsec-app/docs/CONNECTOR_SURFACE.mdarxsec-app/docs/OPERATIONS_SURFACE.md
Maintenance Rule
When a new implementation surface is added here, update one of these places in the same change:
- API/runtime:
docs/api/orarxsec-api/docs/ - Frontend/dashboard:
arxsec-api/frontend/docs/ - Connector:
docs/connectors/plus the connector catalog - Reference agent:
reference-agents/INDEX.mdand the per-agent README - Operations:
docs/ops/ordocs/deployment/