Skip to content

docs: standardize documentation distribution#25

Open
nicosampler wants to merge 2 commits into
mainfrom
feat/docs_organization
Open

docs: standardize documentation distribution#25
nicosampler wants to merge 2 commits into
mainfrom
feat/docs_organization

Conversation

@nicosampler
Copy link
Copy Markdown
Collaborator

Summary

Closes #17

Standardizes the documentation distribution model so README, AGENTS, CLAUDE, and architecture docs each have a clear reader, scope, and placement rule.

Changes

  • Moved canonical agent rules into root AGENTS.md and made CLAUDE.md files compatibility shims.
  • Added delta AGENTS.md/CLAUDE.md files for wallet-service, canton-connect-kit, and dapp/e2e.
  • Added canton-connect-kit/architecture.md and linked it from root architecture docs.
  • Trimmed duplicated setup details from subproject docs and linked shared local-loop instructions upward.

Acceptance criteria

  • Research confirms or revises the proposed distribution model against the actual state of each subproject and any team conventions.
  • The doc-distribution convention is written into a canonical location with one-reader-per-doc, per-file tier rules, and deltas-only guidance.
  • Each existing subproject doc is audited; root-rule duplication is removed or routed upward.
  • AGENTS.md is co-located with every CLAUDE.md and nowhere else.
  • New delta docs are created where warranted, and non-warranted candidates are recorded with reasons.
  • Subproject READMEs link to root setup instead of restating the shared local loop.
  • Root architecture.md stays seam-focused and points to subproject internals instead of duplicating them.

Test plan

Automated tests

  • git diff --cached --check
  • commit hook: commitlint passed; lint-staged had no matching staged files
  • git push --dry-run -u origin feat/docs_organization ran the pre-push TypeScript sweep: carpincho-wallet, dapp/frontend, canton-barebones/wallet-service, canton-connect-kit
  • git push -u origin feat/docs_organization reran the same pre-push TypeScript sweep and passed

Manual verification

Breaking changes

None.

Checklist

  • Self-reviewed my own diff
  • Tests added or updated
  • Docs updated (if applicable)
  • No unrelated changes bundled in

Screenshots

None.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
carpincho-wallet Ready Ready Preview, Comment Jun 4, 2026 1:27am

Request Review

@nicosampler nicosampler marked this pull request as ready for review June 3, 2026 21:15
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.

Standardize documentation distribution across the monorepo and subprojects

2 participants