Skip to content

Docs: reconcile architecture docs with actual repo layout #615

@Otaiki1

Description

@Otaiki1

Build location

Work primarily in docs/ARCHITECTURE.md. Keep related tests/docs beside that package unless this issue explicitly calls for a cross-package update.

Why this matters

Architecture docs still describe contracts as a separate repo and include idealized structures that may drift from current packages.

What to build

  • Audit docs/ARCHITECTURE.md against client, sdk, backend, indexer, oracle, and docs directories.
  • Mark external contract assumptions clearly.
  • Add an updated package responsibility map.

Acceptance criteria

  • Docs identify actual build locations for major features.
  • Outdated paths are removed or clearly labeled as planned.

Suggested verification

Run the affected package checks listed in this issue, plus the root build when the change crosses package boundaries.

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions