Skip to content

Latest commit

 

History

History
349 lines (303 loc) · 12.6 KB

File metadata and controls

349 lines (303 loc) · 12.6 KB

Documentation Reorganization Plan

Created: April 7, 2026 Status: Draft - Pending Review

Current State

  • 141 markdown files in docs/ root (too many)
  • 18 subdirectories already exist (good foundation)
  • Multiple redundant/overlapping documents
  • Legacy implementation docs mixed with current docs
  • Missing documentation for recent features

Reorganization Strategy

Phase 1: File Categorization

Move files from docs/ root to appropriate subdirectories:

1. Agent Systemdocs/agents/

  • AGENT_GOVERNANCE.mdagents/governance.md
  • AGENT_GOVERNANCE_LEARNING_INTEGRATION.mdagents/governance-learning.md
  • AGENT_GRADUATION_GUIDE.mdagents/graduation.md
  • AGENT_GUIDANCE_IMPLEMENTATION.mdagents/guidance-system.md
  • AGENT_MARKETPLACE.mdagents/marketplace.md
  • AGENTS.mdagents/overview.md
  • STUDENT_AGENT_TRAINING_IMPLEMENTATION.mdagents/training.md

2. AI & Intelligencedocs/intelligence/

  • AI_DEBUG_QUICK_START.mdintelligence/debug-quickstart.md
  • AI_DEBUG_SYSTEM.mdintelligence/debug-system.md
  • EPISODIC_MEMORY_IMPLEMENTATION.mdintelligence/episodic-memory.md
  • WORLD_MODEL_IMPLEMENTATION.mdintelligence/world-model.md
  • GRAPHRAG_AND_ENTITY_TYPES.mdintelligence/graphrag.md
  • ai-world-model.mdintelligence/world-model-guide.md

3. Canvas & Presentationsdocs/canvas/

  • CANVAS_AGENT_LEARNING_INTEGRATION.mdcanvas/agent-learning.md
  • CANVAS_AI_ACCESSIBILITY.mdcanvas/ai-accessibility.md
  • CANVAS_FEEDBACK_EPISODIC_MEMORY.mdcanvas/feedback-memory.md
  • CANVAS_QUICK_REFERENCE.mdcanvas/quick-reference.md
  • CANVAS_RECORDING_IMPLEMENTATION.mdcanvas/recording.md
  • CANVAS_STATE_API.mdcanvas/state-api.md
  • LLM_CANVAS_SUMMARIES.mdcanvas/llm-summaries.md

4. Integration & Automationdocs/integrations/

  • ADVANCED_SKILL_EXECUTION.mdintegrations/advanced-skills.md
  • ATOM_OPENCLAW_FEATURES.mdintegrations/openclaw-features.md
  • BROWSER_AUTOMATION.mdintegrations/browser-automation.md
  • BROWSER_QUICK_START.mdintegrations/browser-quickstart.md
  • COMMUNITY_SKILLS.mdintegrations/community-skills.md
  • DEVICE_CAPABILITIES.mdintegrations/device-capabilities.md
  • INTEGRATIONS.mdintegrations/overview.md
  • ATOM_CLI_SKILLS_GUIDE.mdintegrations/cli-skills.md

5. Marketplacedocs/marketplace/

  • MARKETPLACE_CONNECTION_GUIDE.mdmarketplace/connection.md
  • MARKETPLACE_UPDATE_SUMMARY.mdmarketplace/update-summary.md
  • MARKETPLACE_ANALYTICS.mdmarketplace/analytics.md
  • SKILL_MARKETPLACE_GUIDE.mdmarketplace/skills.md

6. Testing & Qualitydocs/testing/

  • TESTING_INDEX.mdtesting/index.md
  • TESTING_ONBOARDING.mdtesting/onboarding.md
  • TESTING_IMPLEMENTATION_PROGRESS.mdtesting/progress.md
  • E2E_TESTING_GUIDE.mdtesting/e2e.md
  • MOBILE_TESTING_GUIDE.mdtesting/mobile.md
  • PROPERTY_TESTING_PATTERNS.mdtesting/property-testing.md
  • CROSS_PLATFORM_COVERAGE.mdtesting/cross-platform.md
  • CROSS_PLATFORM_PROPERTY_TESTING.mdtesting/cross-platform-property.md
  • DESKTOP_COVERAGE.mdtesting/desktop.md
  • DESKTOP_TESTING_GUIDE.mdtesting/desktop-guide.md

7. Deployment & Operationsdocs/operations/

  • DEPLOYMENT.mdoperations/deployment.md
  • DEPLOYMENT_GUIDE.mdoperations/deployment-guide.md
  • PERSONAL_EDITION.mdoperations/personal-edition.md
  • MONITORING_GUIDE.mdoperations/monitoring.md
  • PERFORMANCE_TUNING.mdoperations/performance.md
  • PRODUCTION_READINESS.mdoperations/production-readiness.md
  • ROLLBACK_PROCEDURE.mdoperations/rollback.md

8. Platform & Architecturedocs/platform/

  • ARCHITECTURE.mdplatform/architecture.md
  • TECHNICAL_OVERVIEW.mdplatform/technical-overview.md
  • DATABASE_ARCHITECTURE.mdplatform/database.md
  • SINGLE_TENANT.mdplatform/single-tenant.md
  • PLATFORM.mdplatform/overview.md

9. API Referencedocs/api/

  • API.mdapi/overview.md
  • API_DOCUMENTATION_INDEX.mdapi/index.md
  • API_TYPE_GENERATION.mdapi/type-generation.md
  • FRONTEND_TO_BACKEND_API.mdapi/frontend-backend.md

10. Developmentdocs/development/

  • DEVELOPMENT.mddevelopment/overview.md
  • DEVELOPMENT_SETUP.mddevelopment/setup.md
  • CODE_QUALITY_GUIDE.mddevelopment/code-quality.md
  • BUILD.mddevelopment/build.md

11. Securitydocs/security/

  • PACKAGE_SECURITY.mdsecurity/packages.md
  • PYTHON_PACKAGES_DEPLOYMENT.mdsecurity/python-packages.md
  • NPM_PACKAGE_SUPPORT.mdsecurity/npm-packages.md

12. Features & Use Casesdocs/features/

  • ATOM_VS_OPENCLAW.mdfeatures/atom-vs-openclaw.md
  • USE_CASES.mdfeatures/use-cases.md
  • FEATURE_MATRIX.mdfeatures/matrix.md

Phase 2: Consolidation & Deduplication

Consolidate Redundant Docs:

  1. Agent Governance (3 files → 1)

    • AGENT_GOVERNANCE.md
    • AGENT_GOVERNANCE_LEARNING_INTEGRATION.md
    • Merge into agents/governance.md with sections
  2. Canvas Documentation (6 files → 3)

    • CANVAS_QUICK_REFERENCE.md + CANVAS_STATE_API.mdcanvas/reference.md
    • Keep separate: canvas/implementation.md, canvas/ai-features.md
  3. Testing Documentation (10 files → 5)

    • Merge coverage docs into testing/coverage.md
    • Merge property testing into testing/property-testing.md
    • Keep guides separate
  4. Deployment (3 files → 2)

    • Merge DEPLOYMENT.md + DEPLOYMENT_GUIDE.mdoperations/deployment.md
    • Keep operations/personal-edition.md separate

Phase 3: Archive Legacy Docs

Move to docs/archive/legacy/:

  • ATOM_SAAS_SYNC_DEPLOYMENT.md (SaaS-specific)
  • CITATION_SYSTEM_GUIDE.md (superseded by world-model docs)
  • DEEPLINK_IMPLEMENTATION.md (implementation detail, not user-facing)
  • MEMORY_INTEGRATION_GUIDE.md (superseded)
  • MENUBAR_* files (platform-specific, move to archive/menubar/)
  • MOBILE_* implementation files (move to archive/mobile/)
  • NATIVE_SETUP.md (outdated)
  • PHASE_* files (implementation history)
  • PROPERTY_TESTING_PATTERNS.md (if duplicated in testing/)
  • PYTHON_PACKAGES.md → consolidate with security/python-packages.md
  • All *_IMPLEMENTATION.md files (unless actively referenced)

Phase 4: Add Missing Documentation

Recent Features (from git history):

  1. WhatsApp Multi-Tenant OAuthintegrations/whatsapp-oauth.md
  2. Marketplace Sync & Analyticsmarketplace/sync-analytics.md
  3. Meta-Agent Routingagents/meta-agent.md
  4. Fleet Admiralagents/fleet-admiral.md
  5. Intent Classifierintelligence/intent-classifier.md
  6. Single-Tenant Architectureplatform/single-tenant.md (exists, verify)

Missing User Guides:

  1. Troubleshooting Guideguides/troubleshooting.md
  2. FAQguides/faq.md
  3. Migration Guide (for updates) → guides/migration.md
  4. Configuration Referencereference/configuration.md

Phase 5: Update Cross-References

  1. Update all markdown links to new paths
  2. Update README.md documentation section
  3. Update docs/README.md index
  4. Update docs/INDEX.md if it exists
  5. Update CLAUDE.md documentation references

Proposed Final Structure

docs/
├── README.md                          # Main documentation hub
├── USER_GUIDE_INDEX.md               # User documentation index
├── INDEX.md                          # Complete documentation index
│
├── agents/                           # Agent System
│   ├── overview.md
│   ├── governance.md
│   ├── graduation.md
│   ├── training.md
│   ├── guidance-system.md
│   ├── meta-agent.md
│   ├── fleet-admiral.md
│   └── marketplace.md
│
├── intelligence/                     # AI & Memory
│   ├── episodic-memory.md
│   ├── world-model.md
│   ├── graphrag.md
│   ├── intent-classifier.md
│   ├── debug-system.md
│   └── cognitive-tiers.md
│
├── canvas/                           # Canvas & Presentations
│   ├── overview.md
│   ├── implementation.md
│   ├── ai-features.md
│   ├── state-api.md
│   └── reference.md
│
├── integrations/                     # Integrations
│   ├── overview.md
│   ├── browser-automation.md
│   ├── community-skills.md
│   ├── cli-skills.md
│   ├── device-capabilities.md
│   └── whatsapp-oauth.md
│
├── marketplace/                      # Marketplace
│   ├── connection.md
│   ├── skills.md
│   ├── analytics.md
│   └── sync.md
│
├── testing/                          # Testing & Quality
│   ├── index.md
│   ├── onboarding.md
│   ├── e2e.md
│   ├── mobile.md
│   ├── desktop.md
│   ├── property-testing.md
│   └── coverage.md
│
├── operations/                       # Operations & Deployment
│   ├── deployment.md
│   ├── personal-edition.md
│   ├── monitoring.md
│   ├── performance.md
│   └── production-readiness.md
│
├── platform/                         # Platform Architecture
│   ├── architecture.md
│   ├── technical-overview.md
│   ├── database.md
│   └── single-tenant.md
│
├── api/                              # API Reference
│   ├── overview.md
│   ├── index.md
│   ├── type-generation.md
│   └── frontend-backend.md
│
├── development/                      # Development
│   ├── overview.md
│   ├── setup.md
│   ├── code-quality.md
│   └── build.md
│
├── security/                         # Security
│   ├── packages.md
│   ├── python-packages.md
│   └── npm-packages.md
│
├── features/                         # Features & Comparisons
│   ├── atom-vs-openclaw.md
│   ├── use-cases.md
│   └── matrix.md
│
├── guides/                           # User Guides
│   ├── QUICKSTART.md
│   ├── USER_GUIDE.md
│   ├── troubleshooting.md
│   ├── faq.md
│   └── migration.md
│
├── reference/                        # Reference Materials
│   ├── configuration.md
│   ├── environment-vars.md
│   └── cli-commands.md
│
└── archive/                          # Archived Documentation
    ├── legacy/
    ├── menubar/
    ├── mobile/
    └── phases/

Implementation Checklist

Phase 1: Categorization (Move files)

  • Create new directory structure
  • Move Agent System docs
  • Move Intelligence docs
  • Move Canvas docs
  • Move Integration docs
  • Move Marketplace docs
  • Move Testing docs
  • Move Operations docs
  • Move Platform docs
  • Move API docs
  • Move Development docs
  • Move Security docs
  • Move Features docs

Phase 2: Consolidation

  • Consolidate Agent Governance docs (3→1)
  • Consolidate Canvas docs (6→3)
  • Consolidate Testing docs (10→5)
  • Consolidate Deployment docs (3→2)
  • Review and merge other redundant docs

Phase 3: Archive

  • Move legacy implementation docs
  • Move SaaS-specific docs
  • Move platform-specific docs
  • Move phase completion docs
  • Update archive index

Phase 4: Add Missing Docs

  • Add WhatsApp OAuth guide
  • Add Marketplace Sync guide
  • Add Meta-Agent documentation
  • Add Fleet Admiral guide
  • Add Intent Classifier docs
  • Add Troubleshooting guide
  • Add FAQ
  • Add Migration guide
  • Add Configuration reference

Phase 5: Update References

  • Update README.md links
  • Update docs/README.md links
  • Update docs/INDEX.md links
  • Update CLAUDE.md references
  • Verify all internal links work

Success Metrics

  • Root docs folder: 141 files → ~20 files (hubs and indexes)
  • Clear navigation: User can find any doc in <3 clicks
  • No redundancy: Each topic documented once
  • Complete coverage: All recent features documented
  • Working links: All internal links verified

Notes

  • Preserve all file history using git mv
  • Create redirect pages for commonly-accessed moved docs
  • Update all documentation indexes after moves
  • Run link checker to verify no broken links
  • Archive rather than delete to preserve history