Reorganize documentation: 72→7 root files, 11-category structure#55
Reorganize documentation: 72→7 root files, 11-category structure#55Krosebrook merged 6 commits intomainfrom
Conversation
Co-authored-by: Krosebrook <214532761+Krosebrook@users.noreply.github.com>
Co-authored-by: Krosebrook <214532761+Krosebrook@users.noreply.github.com>
Co-authored-by: Krosebrook <214532761+Krosebrook@users.noreply.github.com>
… summary Co-authored-by: Krosebrook <214532761+Krosebrook@users.noreply.github.com>
Co-authored-by: Krosebrook <214532761+Krosebrook@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR reorganizes scattered root-level documentation into a structured docs/ taxonomy, removes duplicates, and updates cross-references across the repo (including .github/ guidance) to improve discoverability and maintenance.
Changes:
- Introduced an 11-category
docs/structure with a newdocs/README.mdhub and removed the legacydocs/index.md. - Added/updated multiple docs in security/reference/operations/planning/etc., plus a
DOCS_MIGRATION.mdmapping/guide. - Updated internal links in root docs and GitHub agent/prompt/instructions files to reflect new paths.
Reviewed changes
Copilot reviewed 27 out of 86 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/security/THREAT-MODEL.md | Updates related-doc links to new docs hierarchy. |
| docs/security/DATA-PRIVACY.md | Updates related-doc links to new docs hierarchy. |
| docs/security/AUTH.md | Adds auth/RBAC documentation. |
| docs/security/AUDIT-LOGS.md | Updates related-doc links to new docs hierarchy. |
| docs/reference/SCHEMAS.md | Fixes links to architecture docs and component schema specs. |
| docs/reference/ERROR-CODES.md | Adds error code reference and response format. |
| docs/reference/ENV-VARS.md | Updates related-doc links to new docs hierarchy. |
| docs/reference/API-CONTRACTS.md | Fixes links to component API reference and security auth doc. |
| docs/planning/SAFE_BRANCH_MERGING.md | Updates links to moved audit/recommendations docs. |
| docs/planning/ROADMAP.md | Updates release-history link to new community location. |
| docs/planning/PRE_MERGE_CHECKLIST.md | Adds a pre-merge checklist template under planning. |
| docs/planning/PRD_GENERATOR_GUIDE.md | Adds usage guide for PRD generator tooling. |
| docs/planning/MIGRATION_STRATEGY.md | Updates references to ADRs/security/operations docs. |
| docs/planning/MIGRATION.md | Adds placeholder migration doc under planning. |
| docs/planning/EXECUTIVE_SUMMARY.md | Adds modernization initiative executive summary. |
| docs/operations/OBSERVABILITY.md | Adds placeholder observability doc under operations. |
| docs/operations/INFRASTRUCTURE.md | Adds infrastructure overview under operations. |
| docs/operations/CI-CD.md | Adds CI/CD doc under operations (includes workflow snippet). |
| docs/operations/BACKUP-RECOVERY.md | Adds placeholder backup/recovery doc under operations. |
| docs/integrations/VECTOR-DB.md | Adds placeholder vector DB integration doc. |
| docs/integrations/AGENTS.md | Adds/relocates agents documentation under integrations. |
| docs/index.md | Removes legacy docs index (replaced by docs/README.md). |
| docs/guides/CLI.md | Adds CLI reference under guides. |
| docs/getting-started/MIGRATION_QUICKSTART.md | Adds quickstart for modernization initiative. |
| docs/getting-started/DEVELOPMENT.md | Adds development guide under getting-started. |
| docs/getting-started/CAPACITOR_SETUP.md | Adds Capacitor Android setup guide under getting-started. |
| docs/development/TOOLS.md | Adds tools catalog under development. |
| docs/development/PERFORMANCE.md | Adds performance targets/strategies under development. |
| docs/development/DEPENDENCIES.md | Adds dependency inventory/policy under development. |
| docs/development/CACHING.md | Adds caching strategy doc under development. |
| docs/development/AI-SAFETY.md | Adds AI safety guidelines under development. |
| docs/community/SUPPORT.md | Adds support channels/resources under community. |
| docs/community/SPONSORS.md | Adds sponsors placeholder under community. |
| docs/community/RELEASES.md | Adds release management doc under community. |
| docs/community/GOVERNANCE.md | Adds governance model under community. |
| docs/community/BRANDING.md | Adds brand guidelines under community. |
| docs/community/AUTHORS.md | Adds contributors/recognition doc under community. |
| docs/community/ATTRIBUTION.md | Adds attribution/licensing acknowledgments under community. |
| docs/audits/REFACTOR_SUMMARY.md | Moves/adds refactor summary under audits. |
| docs/audits/MERGE_IMPLEMENTATION_SUMMARY.md | Moves/adds merge implementation summary under audits. |
| docs/audits/IMPLEMENTATION_SUMMARY.md | Moves/adds implementation summary under audits. |
| docs/audits/IMPLEMENTATION_COMPLETE.md | Moves/adds implementation completion summary under audits. |
| docs/audits/BUNDLE_SIZE_REPORT.md | Moves/adds bundle size report under audits. |
| docs/audits/BASE44_MIGRATION_AUDIT.md | Updates ADR link path to new relative location. |
| docs/architecture/STATE-MACHINE.md | Adds state machine doc under architecture. |
| docs/architecture/ERD.md | Adds ERD doc under architecture. |
| docs/architecture/DATA-FLOW.md | Adds data-flow doc under architecture. |
| docs/architecture/ARCHITECTURE_OVERVIEW.md | Updates data-flow link to new in-folder architecture doc. |
| docs/README.md | Adds master docs hub index for the new taxonomy. |
| README.md | Updates key documentation links to new docs structure. |
| MANIFESTO.md | Removes duplicate/generic manifesto doc. |
| FAQ.md | Updates links to the new docs structure. |
| DOCS_MIGRATION.md | Adds migration mapping, link update patterns, and maintenance guidance. |
| CONTRIBUTING.md | Updates links to moved testing/audits/roadmap docs. |
| .github/prompts/agent-typescript-migration.md | Updates PRD reference path. |
| .github/prompts/agent-cognitive-loop.md | Updates PRD reference path. |
| .github/prompts/agent-ai-recommendations.md | Updates PRD reference path. |
| .github/copilot-instructions.md | Updates references to moved planning/audit docs. |
| .github/base44-updates.md | Updates PRD/roadmap references to new docs paths. |
| .github/agents/documentation-writer.agent.md | Updates example directory structure and doc references. |
| .github/agents.md | Updates PRD/roadmap references to new docs paths. |
| .github/FEATURE_TO_PR_TEMPLATE.md | Updates CODEBASE_AUDIT/PRD/roadmap reference paths. |
|
@copilot apply changes based on the comments in this thread |
There was a problem hiding this comment.
4 issues found across 86 files
Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed.
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name=".github/agents/documentation-writer.agent.md">
<violation number="1" location=".github/agents/documentation-writer.agent.md:23">
P3: The updated directory tree now implies `security/`, `api/`, and `guides/` are children of `CONTRIBUTING.md` because the old subtree lines were left in place. Update the tree so these directories are properly nested under `docs/` (or removed if they no longer exist) to avoid misleading structure.</violation>
</file>
<file name="DOCS_MIGRATION.md">
<violation number="1" location="DOCS_MIGRATION.md:15">
P3: The root file count is off by one; DOCS_MIGRATION.md itself lives at the repo root, so the cleanup should reflect 7 files instead of 6.</violation>
<violation number="2" location="DOCS_MIGRATION.md:91">
P3: The planning section count is incorrect; it lists 11 files but claims 10.</violation>
<violation number="3" location="DOCS_MIGRATION.md:103">
P3: The audits section count is incorrect; it lists 10 files but claims 9.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| ├── FEATURE_ROADMAP.md # 18-month roadmap | ||
| ├── TESTING.md # Testing guide | ||
| ├── CODEBASE_AUDIT.md # Technical audit | ||
| ├── docs/ |
There was a problem hiding this comment.
P3: The updated directory tree now implies security/, api/, and guides/ are children of CONTRIBUTING.md because the old subtree lines were left in place. Update the tree so these directories are properly nested under docs/ (or removed if they no longer exist) to avoid misleading structure.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At .github/agents/documentation-writer.agent.md, line 23:
<comment>The updated directory tree now implies `security/`, `api/`, and `guides/` are children of `CONTRIBUTING.md` because the old subtree lines were left in place. Update the tree so these directories are properly nested under `docs/` (or removed if they no longer exist) to avoid misleading structure.</comment>
<file context>
@@ -20,14 +20,18 @@ The Interact platform has extensive documentation with a score of **98/100** (as
-├── FEATURE_ROADMAP.md # 18-month roadmap
-├── TESTING.md # Testing guide
-├── CODEBASE_AUDIT.md # Technical audit
+├── docs/
+│ ├── README.md # Documentation hub
+│ ├── planning/
</file context>
| │ ├── RECOMMENDATIONS.md | ||
| │ ├── ROADMAP.md | ||
| │ └── SAFE_BRANCH_MERGING.md | ||
| ├── audits/ # 9 files |
There was a problem hiding this comment.
P3: The audits section count is incorrect; it lists 10 files but claims 9.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At DOCS_MIGRATION.md, line 103:
<comment>The audits section count is incorrect; it lists 10 files but claims 9.</comment>
<file context>
@@ -0,0 +1,308 @@
+│ ├── RECOMMENDATIONS.md
+│ ├── ROADMAP.md
+│ └── SAFE_BRANCH_MERGING.md
+├── audits/ # 9 files
+│ ├── BASE44_MIGRATION_AUDIT.md
+│ ├── BUNDLE_SIZE_REPORT.md
</file context>
| │ ├── PROMPTS.md | ||
| │ ├── TOOLS.md | ||
| │ └── TYPESCRIPT_MIGRATION.md | ||
| ├── planning/ # 10 files |
There was a problem hiding this comment.
P3: The planning section count is incorrect; it lists 11 files but claims 10.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At DOCS_MIGRATION.md, line 91:
<comment>The planning section count is incorrect; it lists 11 files but claims 10.</comment>
<file context>
@@ -0,0 +1,308 @@
+│ ├── PROMPTS.md
+│ ├── TOOLS.md
+│ └── TYPESCRIPT_MIGRATION.md
+├── planning/ # 10 files
+│ ├── BRANCH_MERGING_PLAN.md
+│ ├── EXECUTIVE_SUMMARY.md
</file context>
|
|
||
| ## Goals Achieved | ||
|
|
||
| ✅ **Root directory cleanup:** 72 → 6 files (Target: ≤10) |
There was a problem hiding this comment.
P3: The root file count is off by one; DOCS_MIGRATION.md itself lives at the repo root, so the cleanup should reflect 7 files instead of 6.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At DOCS_MIGRATION.md, line 15:
<comment>The root file count is off by one; DOCS_MIGRATION.md itself lives at the repo root, so the cleanup should reflect 7 files instead of 6.</comment>
<file context>
@@ -0,0 +1,308 @@
+
+## Goals Achieved
+
+✅ **Root directory cleanup:** 72 → 6 files (Target: ≤10)
+✅ **Organized structure:** 11 logical categories
+✅ **Git history preserved:** All files moved with `git mv`
</file context>
Problem
Repository root contained 72+ markdown files with no organizational structure, causing poor discoverability and maintenance burden. Multiple duplicate files (e.g.,
PRODUCT_REQUIREMENTS_DOCUMENT.mdvsPRD.md) and inconsistent cross-references.Changes
Structure
docs/:getting-started/,architecture/,guides/,reference/,operations/,security/,development/,planning/,audits/,integrations/,community/git mvto preserve historyREADME.md,CHANGELOG.md,CONTRIBUTING.md,CODE_OF_CONDUCT.md,FAQ.md,SECURITY.md,DOCS_MIGRATION.mdLinks & References
.github/configuration files (copilot-instructions, agents, prompts)Cleanup
PRODUCT_REQUIREMENTS_DOCUMENT.md(keptdocs/planning/PRD.md)MANIFESTO.md(420 bytes)docs/index.mdwith comprehensivedocs/README.mdmaster indexMigration
Created
DOCS_MIGRATION.mddocumenting:All git history preserved. All links validated.
Original prompt
Documentation Reorganization
Problem Statement
The Krosebrook/interact repository currently has 80+ markdown documentation files scattered at the root level, making the repository extremely difficult to navigate and maintain. This creates several issues:
Objectives
Reorganize all documentation into a clear, maintainable structure that:
Proposed Structure
Root Level (Keep only these)
docs/ Directory Organization
Documentation to Remove/Consolidate
Remove (Duplicates/Outdated)
Consolidate
Implementation Tasks
git mvto preserve history)](./or](/and update pathsFiles to Create
Link Update Pattern
When moving files, update all references from:
To:
And update root-level references:
Validation
After migration:
renamed)Success Criteria
This pull request was created from Copilot chat.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.
Summary by cubic
Reorganized documentation under docs/ with a new docs/README.md hub, updated links across the repo and .github, and removed duplicates to improve navigation and maintenance. Fixed remaining relative path references across architecture, planning, reference, and security docs.
Refactors
Migration
Written for commit a1e663d. Summary will update on new commits.