docs: adopt four-bucket docs layout and progressive AGENTS index - #2374
Draft
azi44eo wants to merge 4 commits into
Draft
docs: adopt four-bucket docs layout and progressive AGENTS index#2374azi44eo wants to merge 4 commits into
azi44eo wants to merge 4 commits into
Conversation
Align the code-repo docs with architecture/guideline/specs/plans, externalize user guides to bitfun_doc, and keep GCWing norms via guideline ops pages plus path-only product/audit reference updates. Co-authored-by: Cursor <cursoragent@cursor.com>
Keep product-facing setup docs in the code repo and retarget README / RemoteConnectDialog links away from bitfun_doc. Co-authored-by: Cursor <cursoragent@cursor.com>
Remove gitcode/bitfun_doc links and out-of-repo placement rules so governance docs focus only on in-repo documentation scope. Co-authored-by: Cursor <cursoragent@cursor.com>
Owner
|
The document status is inconsistent with the current repository, and since the document affects AI behavior—yet repository-side maintenance of it will be reduced going forward—this PR will not be merged. |
bobleer
marked this pull request as draft
August 20, 2026 02:29
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Align the code repository around four authoritative documentation buckets —
architecture/,guideline/,specs/, andplans/— and turn the rootAGENTSfiles into progressive-disclosure indexes.Summary
AGENTSguidance through standards, architecture, cross-cutting, and task-based maps.tokio/fullprohibition and owner-scoped Rust verification.Type and Areas
Type: documentation / repository governance
Areas: root
AGENTSand contributor entrypoints,docs/, Web UI documentation URLs, appearance audit documentation pathsMotivation / Impact
The old layout mixed stable architecture, operational rules, feature designs, plans, product setup guides, research, and temporary-process paths. The new layout gives each durable document one canonical owner while keeping high-frequency rules discoverable within two hops from
AGENTS.md.There is no product-logic change. User-visible impact is limited to documentation/help links, and legacy public paths remain reachable for already released clients.
Migration Map
docs/development/{i18n,releasing,ui-testids*}docs/guideline/docs/remote-connect/feishu-bot-setup*docs/guideline/feishu-bot-setup*; old paths retained as compatibility pointersdocs/verify-downloads*docs/guideline/verify-downloads*; old paths retained as compatibility pointersdocs/features/{agent-hooks*,remote-workspaces,session-runtime-usage-report-design}docs/specs/; old public paths retained as compatibility pointersdocs/superpowers/specs/*docs/specs/*docs/superpowers/plans/*docs/plans/*-plan.mddocs/sdlc-harness/architecture/*anddesign.mddocs/architecture/*anddocs/architecture/sdlc-governance-architecture.mddocs/sdlc-harness/features/*, product requirements, metrics, and traceabilitydocs/specs/*docs/sdlc-harness/{implementation-plan,agent-workflow-staged-plan}.mddocs/plans/sdlc-governance-*.mddocs/sdlc-harness/governance/self-governance-notes.mddocs/guideline/self-governance-notes.mddocs/sdlc-harness/research/external-research.mddocs/specs/sdlc-governance-external-research.mdas a dated non-normative referencedocs/performance/01-compile-performance.mddocs/plans/2026-08-14-compile-and-dependency-governance-plan.mddocs/performance/02-04reviewsreferencedocuments underdocs/specs/; implementation requires revalidationdocs/sdlc-harness/README.mddocs/architecture/sdlc-governance-architecture.mddocs/specs/templates/plan.mdintroduced by the initial migrationdocs/plans/templates/plan.mdCompatibility / Reviewer Notes
bitfun_docrepository.docs/README.md.Verification
git diff --checkpnpm run check:repo-hygienepnpm --dir src/web-ui run gen:types— 34 tests passedpnpm run type-check:webpnpm run appearance:contract-audit— passed; 16 existing advisory warningsdocs/README.mdanddocs/guideline/docs-governance.mdChecklist