Skip to content

docs: architecture overview with workspace map and data flow - #1211

Open
autarch-agent wants to merge 1 commit into
Samuel1-ona:mainfrom
autarch-agent:docs-1147-architecture
Open

docs: architecture overview with workspace map and data flow#1211
autarch-agent wants to merge 1 commit into
Samuel1-ona:mainfrom
autarch-agent:docs-1147-architecture

Conversation

@autarch-agent

Copy link
Copy Markdown

What

Adds docs/architecture.md (#1147): workspace boundaries, module map, data-flow diagram, and the shared-types ownership rule.

Contents

  • Workspaces table: apps/web, apps/mobile, packages/types|config|ui with purpose + key contents
  • Shared types ownership: states explicitly that packages/types is the single source of truth (@hunty/types), including where API schemas live
  • Module map of apps/web: api/v1 surface, huntStore, answer validation/verification, anti-cheat, analytics, contracts bindings, social features
  • ASCII data-flow diagram: UI → domain logic → persistence (localStorage / API v1 / Soroban contracts), with @hunty/types as the shared contract layer
  • Contributor rules: where to put cross-app types, new route schemas, shared UI primitives

All cited modules were verified to exist in the repo before documenting them.

Resolves #1147

Implements Samuel1-ona#1147:
- docs/architecture.md describes each workspace and its boundaries
  (apps/web, apps/mobile, packages/types|config|ui)
- ASCII diagram shows the data flow from UI to domain logic to
  persistence/Soroban contracts
- states explicitly that packages/types owns shared types, with
  contributor rules for where schemas/components belong
- all cited modules verified to exist in the repo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOCS] Publish an architecture overview with a module map

1 participant