Skip to content

Remove Docusaurus documentation system#849

Merged
sean-esk merged 1 commit intomainfrom
feature/remove-docusaurus-documentation
Nov 12, 2025
Merged

Remove Docusaurus documentation system#849
sean-esk merged 1 commit intomainfrom
feature/remove-docusaurus-documentation

Conversation

@leex279
Copy link
Copy Markdown
Collaborator

@leex279 leex279 commented Nov 8, 2025

Summary

This PR removes the standalone Docusaurus documentation website to simplify the project structure and reduce maintenance overhead.

Changes Made

Deleted:

  • /docs directory (480MB freed - entire Docusaurus installation with 35 MDX files)
  • docker-compose.docs.yml (optional docs service on port 3838)
  • ARCHON_DOCS_PORT=3838 environment variable from .env.example

Updated:

  • .github/workflows/release-notes.yml - Removed documentation section
  • .github/test-release-notes.sh - Removed documentation section generation

Preserved (Critical):

  • ✅ Project documents feature (archon-ui-main/src/features/projects/documents/)
  • ✅ Backend document service (python/src/server/services/projects/document_service.py)
  • ✅ Project documents API endpoints (/api/projects/{id}/docs)

Benefits

  • Eliminates redundancy: Documentation content was duplicated in /PRPs/ai_docs/ which is more actively maintained
  • Reduces complexity: Removes 480MB of dependencies, build artifacts, and configuration
  • Simplifies deployment: Eliminates optional Docker service and port 3838 management
  • Lowers maintenance burden: Single documentation source instead of maintaining two systems
  • Prevents confusion: Clear distinction between developer docs (PRPs) and project management features

Test Results

All validation levels passed successfully:

✓ Level 1: File System Validation

  • All files deleted successfully
  • No Docusaurus references remain in codebase
  • Project documents feature intact

✓ Level 2: Build Validation

  • Backend imports successful (no errors)
  • No missing dependencies

✓ Level 3: Integration Testing

  • Docker Compose services start successfully
  • Main UI accessible (port 3737)
  • Backend API healthy (port 8181)
  • Critical: Project documents API works perfectly (/api/projects/{id}/docs)
  • Port 3838 not in use (docs service removed)
  • No archon-docs Docker service exists

✓ Level 4: CI/CD & Workflow Validation

  • Release notes workflow validated
  • Test script runs without errors
  • No documentation references in workflows

Impact Summary

  • 67 files changed: 1 insertion, 36,423 deletions
  • Disk space: 480MB freed
  • Docker services: Reduced from 4 to 3 (removed archon-docs)
  • Ports: Freed port 3838
  • Breaking changes: None - project documents feature fully functional

Critical Verification

The two "docs" concepts were correctly distinguished:

  • ❌ Removed: /docs folder (Docusaurus documentation website)
  • ✅ Preserved: Project documents feature (core application functionality)

All project documents API endpoints continue to work correctly.

Test Plan

  • File system validation (all files removed)
  • Backend imports successful
  • Docker Compose starts all services
  • Main UI accessible at http://localhost:3737
  • Backend API healthy at http://localhost:8181/health
  • Project documents API functional
  • Port 3838 not in use
  • No docs-related errors in logs
  • CI/CD workflows validated

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Chores
    • Removed Docusaurus documentation site infrastructure and all associated documentation files
    • Removed Docker Compose documentation service configuration
    • Removed documentation port from environment configuration
    • Updated release notes generation to exclude documentation changes

Remove the standalone Docusaurus documentation website to simplify the project structure and reduce maintenance overhead.

Changes:
- Delete /docs directory (480MB freed) containing all Docusaurus files
- Remove docker-compose.docs.yml (optional docs service)
- Remove ARCHON_DOCS_PORT from .env.example
- Update .github/workflows/release-notes.yml (remove docs section)
- Update .github/test-release-notes.sh (remove docs section)

Preserved:
- Project documents feature (archon-ui-main/src/features/projects/documents/)
- Backend document service (python/src/server/services/projects/document_service.py)
- Project documents API endpoints (/api/projects/{id}/docs)

Benefits:
- Eliminates redundancy (content duplicated in /PRPs/ai_docs/)
- Reduces complexity (removes 480MB dependencies and configuration)
- Simplifies deployment (eliminates optional Docker service on port 3838)
- Lowers maintenance burden (single documentation source)

All validation tests passed:
✓ File system validation
✓ Backend imports verification
✓ Docker Compose integration testing
✓ CI/CD workflow validation
✓ Project documents API still functional

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Nov 8, 2025

Walkthrough

Complete removal of the Docusaurus-based documentation site infrastructure, including build configuration, all documentation content files, styling assets, Docker support, and automated release notes generation logic tied to documentation.

Changes

Cohort / File(s) Summary
Environment & Service Configuration
.env.example, docker-compose.docs.yml
Removed ARCHON_DOCS_PORT environment variable and deleted Docker Compose configuration for the docs service (build, port mapping, container name, network setup).
Release Notes Automation
.github/test-release-notes.sh, .github/workflows/release-notes.yml
Removed documentation-related diff filtering and sections from release notes generation pipeline, eliminating the Documentation section and associated Markdown file diffing logic.
Docusaurus Configuration & Build
docs/Dockerfile, docs/babel.config.js, docs/package.json, docs/docusaurus.config.js, docs/sidebars.js
Deleted multi-stage Dockerfile for building and serving Docusaurus site, Babel preset configuration, npm dependency manifest, site configuration (metadata, theming, presets, navigation), and sidebar structure definitions.
Documentation Content
docs/docs/*.mdx, docs/docs/README.md
Removed 28 MDX documentation pages and the docs directory README covering: Getting Started, API Reference, Architecture, Server/MCP/Agents/RAG/Projects overviews, configuration guides, deployment, testing strategies, Socket.IO patterns, background tasks, UI components, and features documentation.
Styling & Frontend Pages
docs/src/css/custom.css, docs/src/pages/index.js, docs/src/pages/index.module.css, docs/src/pages/markdown-page.md, docs/static/js/mermaid-rounded-corners.js
Removed Aurora Glass Theme CSS (color palette, component styling, responsive rules), homepage React component with architecture diagrams, homepage CSS module with hero and layout styles, example markdown page, and Mermaid diagram rounded corners utility script.
Repository Configuration
docs/.gitignore, docs/README.md
Removed docs-specific Git ignore rules and documentation site README with build/deployment instructions.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Rationale: This is a large, homogeneous set of deletions (50+ files all being removed) with no new logic or complex changes to evaluate. While the scope is significant, the repetitive nature of the changes (complete removal of a subsystem) and lack of interdependencies or conditional logic make the review straightforward—primarily verifying that all deletions are intentional and complete.

Possibly related PRs

Poem

🐰 With a hop and a bound, the docs take their flight,
Deleted and swept clean into the night.
No Docusaurus left, no pages to see,
Just code standing pure, wild and free!

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description is comprehensive and well-structured, covering summary, changes made, benefits, test results, and impact. However, it deviates from the required template by not following the specified sections (Type of Change, Affected Services, Testing checklist format, etc.). Consider restructuring the description to match the repository template: include Type of Change checkboxes, Affected Services section, Testing section with specific test commands, and complete the Checklist items for consistency.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Remove Docusaurus documentation system' accurately and concisely describes the main objective of the PR, which is the removal of the Docusaurus-based documentation website.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/remove-docusaurus-documentation

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 33f1db3 and 49e8db9.

⛔ Files ignored due to path filters (16)
  • docs/package-lock.json is excluded by !**/package-lock.json
  • docs/static/img/Python-logo-notext.svg is excluded by !**/*.svg
  • docs/static/img/React-icon.svg is excluded by !**/*.svg
  • docs/static/img/Visual_Studio_Code_1.35_icon.svg is excluded by !**/*.svg
  • docs/static/img/claude-logo.svg is excluded by !**/*.svg
  • docs/static/img/cursor.svg is excluded by !**/*.svg
  • docs/static/img/docusaurus.png is excluded by !**/*.png
  • docs/static/img/fastapi-seeklogo.svg is excluded by !**/*.svg
  • docs/static/img/favicon.ico is excluded by !**/*.ico
  • docs/static/img/favicon.svg is excluded by !**/*.svg
  • docs/static/img/logo-neon.svg is excluded by !**/*.svg
  • docs/static/img/logo.svg is excluded by !**/*.svg
  • docs/static/img/mcp.svg is excluded by !**/*.svg
  • docs/static/img/tutorial/docsVersionDropdown.png is excluded by !**/*.png
  • docs/static/img/tutorial/localeDropdown.png is excluded by !**/*.png
  • docs/static/img/windsurf-white-symbol.svg is excluded by !**/*.svg
📒 Files selected for processing (50)
  • .env.example (0 hunks)
  • .github/test-release-notes.sh (1 hunks)
  • .github/workflows/release-notes.yml (0 hunks)
  • docker-compose.docs.yml (0 hunks)
  • docs/.gitignore (0 hunks)
  • docs/Dockerfile (0 hunks)
  • docs/README.md (0 hunks)
  • docs/babel.config.js (0 hunks)
  • docs/docs/README.md (0 hunks)
  • docs/docs/agent-chat.mdx (0 hunks)
  • docs/docs/agent-document.mdx (0 hunks)
  • docs/docs/agent-rag.mdx (0 hunks)
  • docs/docs/agent-task.mdx (0 hunks)
  • docs/docs/agents-overview.mdx (0 hunks)
  • docs/docs/api-reference.mdx (0 hunks)
  • docs/docs/architecture.mdx (0 hunks)
  • docs/docs/background-tasks.mdx (0 hunks)
  • docs/docs/code-extraction-rules.mdx (0 hunks)
  • docs/docs/coding-best-practices.mdx (0 hunks)
  • docs/docs/configuration.mdx (0 hunks)
  • docs/docs/crawling-configuration.mdx (0 hunks)
  • docs/docs/deployment.mdx (0 hunks)
  • docs/docs/getting-started.mdx (0 hunks)
  • docs/docs/intro.mdx (0 hunks)
  • docs/docs/knowledge-features.mdx (0 hunks)
  • docs/docs/knowledge-overview.mdx (0 hunks)
  • docs/docs/mcp-overview.mdx (0 hunks)
  • docs/docs/mcp-server.mdx (0 hunks)
  • docs/docs/mcp-tools.mdx (0 hunks)
  • docs/docs/projects-features.mdx (0 hunks)
  • docs/docs/projects-overview.mdx (0 hunks)
  • docs/docs/rag.mdx (0 hunks)
  • docs/docs/server-deployment.mdx (0 hunks)
  • docs/docs/server-monitoring.mdx (0 hunks)
  • docs/docs/server-overview.mdx (0 hunks)
  • docs/docs/server-services.mdx (0 hunks)
  • docs/docs/socketio.mdx (0 hunks)
  • docs/docs/testing-python-strategy.mdx (0 hunks)
  • docs/docs/testing-vitest-strategy.mdx (0 hunks)
  • docs/docs/testing.mdx (0 hunks)
  • docs/docs/ui-components.mdx (0 hunks)
  • docs/docs/ui.mdx (0 hunks)
  • docs/docusaurus.config.js (0 hunks)
  • docs/package.json (0 hunks)
  • docs/sidebars.js (0 hunks)
  • docs/src/css/custom.css (0 hunks)
  • docs/src/pages/index.js (0 hunks)
  • docs/src/pages/index.module.css (0 hunks)
  • docs/src/pages/markdown-page.md (0 hunks)
  • docs/static/js/mermaid-rounded-corners.js (0 hunks)
💤 Files with no reviewable changes (49)
  • docs/docs/architecture.mdx
  • docs/docs/server-monitoring.mdx
  • docs/docs/server-overview.mdx
  • docs/docs/agents-overview.mdx
  • docs/docs/mcp-tools.mdx
  • docs/docs/ui-components.mdx
  • docs/docs/coding-best-practices.mdx
  • docs/sidebars.js
  • docs/docs/agent-rag.mdx
  • docs/package.json
  • docs/docs/projects-features.mdx
  • docs/static/js/mermaid-rounded-corners.js
  • docs/docs/testing-python-strategy.mdx
  • docs/.gitignore
  • docs/docs/testing-vitest-strategy.mdx
  • docs/docs/knowledge-features.mdx
  • docs/src/css/custom.css
  • docs/docs/knowledge-overview.mdx
  • docs/docs/agent-document.mdx
  • docs/docs/projects-overview.mdx
  • docs/docs/intro.mdx
  • docs/src/pages/index.module.css
  • docs/docs/background-tasks.mdx
  • docs/Dockerfile
  • docs/docs/mcp-server.mdx
  • docs/docs/socketio.mdx
  • docs/docs/getting-started.mdx
  • docs/docs/server-services.mdx
  • docs/docusaurus.config.js
  • docs/src/pages/markdown-page.md
  • docs/docs/deployment.mdx
  • .env.example
  • docs/docs/configuration.mdx
  • docs/docs/crawling-configuration.mdx
  • docs/babel.config.js
  • docs/docs/code-extraction-rules.mdx
  • docs/README.md
  • docs/docs/api-reference.mdx
  • docs/docs/agent-task.mdx
  • docs/docs/testing.mdx
  • docs/docs/README.md
  • docs/docs/mcp-overview.mdx
  • docs/docs/agent-chat.mdx
  • .github/workflows/release-notes.yml
  • docs/docs/rag.mdx
  • docs/docs/server-deployment.mdx
  • docs/docs/ui.mdx
  • docs/src/pages/index.js
  • docker-compose.docs.yml
🔇 Additional comments (1)
.github/test-release-notes.sh (1)

114-124: Documentation removal is complete and correct.

Verification confirms all documentation references have been successfully removed from the script—no remaining docs/ paths, CHANGES_DOCS variables, or Documentation section headers. The script now correctly processes only frontend and backend components, aligning with the PR's objective to eliminate Docusaurus documentation.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@leex279 leex279 marked this pull request as ready for review November 8, 2025 17:35
@sean-esk sean-esk merged commit 7e66f34 into main Nov 12, 2025
8 checks passed
@Wirasm Wirasm deleted the feature/remove-docusaurus-documentation branch April 6, 2026 07:38
coleam00 pushed a commit that referenced this pull request Apr 7, 2026
…s (step 2.3) (#849)

* refactor(workflows): eliminate barrel exports — direct subpath imports (step 2.3) (#846)

Delete packages/workflows/src/index.ts and replace the `"."` barrel entry
in package.json exports with an explicit 17-entry subpath map. All 13 source
files and 12 test files across @archon/core, @archon/cli, and @archon/server
now import from specific subpaths (e.g. @archon/workflows/executor,
@archon/workflows/schemas/workflow) instead of the opaque barrel.

Test mock.module() calls are split per-subpath so spies target the same
module reference that the handler under test imports from. Updates CLAUDE.md
import convention docs to show direct-subpath-only examples.

Fixes #846

* style: auto-fix prettier formatting in auth-service/server.js

* docs: remove stale index.ts entry from workflows directory structure

packages/workflows/src/index.ts was deleted in this PR but the
CLAUDE.md directory tree still listed it. Remove the stale entry.

* fix: address review findings — trim unused exports, fix docs

- Remove 5 unused exports from package.json (executor-shared, dag-executor,
  model-validation, utils/variable-substitution, schemas barrel) — YAGNI
- Fix CLAUDE.md tree character (├── → └── on utils/, last child)
- Remove redundant barrel wrong-example block from CLAUDE.md (compiler
  already enforces this since there's no "." export entry)
- Clarify @archon/web import prohibition scope in CLAUDE.md
- Update docs/cli-developer-guide.md: stale discoverWorkflows →
  discoverWorkflowsWithConfig, barrel refs → direct subpaths
Tyone88 pushed a commit to Tyone88/Archon that referenced this pull request Apr 16, 2026
…s (step 2.3) (coleam00#849)

* refactor(workflows): eliminate barrel exports — direct subpath imports (step 2.3) (coleam00#846)

Delete packages/workflows/src/index.ts and replace the `"."` barrel entry
in package.json exports with an explicit 17-entry subpath map. All 13 source
files and 12 test files across @archon/core, @archon/cli, and @archon/server
now import from specific subpaths (e.g. @archon/workflows/executor,
@archon/workflows/schemas/workflow) instead of the opaque barrel.

Test mock.module() calls are split per-subpath so spies target the same
module reference that the handler under test imports from. Updates CLAUDE.md
import convention docs to show direct-subpath-only examples.

Fixes coleam00#846

* style: auto-fix prettier formatting in auth-service/server.js

* docs: remove stale index.ts entry from workflows directory structure

packages/workflows/src/index.ts was deleted in this PR but the
CLAUDE.md directory tree still listed it. Remove the stale entry.

* fix: address review findings — trim unused exports, fix docs

- Remove 5 unused exports from package.json (executor-shared, dag-executor,
  model-validation, utils/variable-substitution, schemas barrel) — YAGNI
- Fix CLAUDE.md tree character (├── → └── on utils/, last child)
- Remove redundant barrel wrong-example block from CLAUDE.md (compiler
  already enforces this since there's no "." export entry)
- Clarify @archon/web import prohibition scope in CLAUDE.md
- Update docs/cli-developer-guide.md: stale discoverWorkflows →
  discoverWorkflowsWithConfig, barrel refs → direct subpaths
joaobmonteiro pushed a commit to joaobmonteiro/Archon that referenced this pull request Apr 26, 2026
…s (step 2.3) (coleam00#849)

* refactor(workflows): eliminate barrel exports — direct subpath imports (step 2.3) (coleam00#846)

Delete packages/workflows/src/index.ts and replace the `"."` barrel entry
in package.json exports with an explicit 17-entry subpath map. All 13 source
files and 12 test files across @archon/core, @archon/cli, and @archon/server
now import from specific subpaths (e.g. @archon/workflows/executor,
@archon/workflows/schemas/workflow) instead of the opaque barrel.

Test mock.module() calls are split per-subpath so spies target the same
module reference that the handler under test imports from. Updates CLAUDE.md
import convention docs to show direct-subpath-only examples.

Fixes coleam00#846

* style: auto-fix prettier formatting in auth-service/server.js

* docs: remove stale index.ts entry from workflows directory structure

packages/workflows/src/index.ts was deleted in this PR but the
CLAUDE.md directory tree still listed it. Remove the stale entry.

* fix: address review findings — trim unused exports, fix docs

- Remove 5 unused exports from package.json (executor-shared, dag-executor,
  model-validation, utils/variable-substitution, schemas barrel) — YAGNI
- Fix CLAUDE.md tree character (├── → └── on utils/, last child)
- Remove redundant barrel wrong-example block from CLAUDE.md (compiler
  already enforces this since there's no "." export entry)
- Clarify @archon/web import prohibition scope in CLAUDE.md
- Update docs/cli-developer-guide.md: stale discoverWorkflows →
  discoverWorkflowsWithConfig, barrel refs → direct subpaths
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.

2 participants