Skip to content

Conversation

@eoln
Copy link
Owner

@eoln eoln commented Aug 15, 2025

Summary

This PR migrates the documentation from package-specific structure to a unified monorepo documentation site, solving pre-commit hook issues and improving maintainability.

Changes

πŸ—οΈ Infrastructure

  • Created root-level MkDocs configuration for entire monorepo
  • Moved eol-rag-context docs to unified structure at docs/packages/
  • Added root-level pre-commit hooks for documentation validation
  • Moved validate_docs.py script to root scripts/ directory

πŸ“š Documentation

  • Created comprehensive landing page for EOL Framework
  • Added package overview with roadmap for future packages
  • Created getting-started guides (installation, quickstart, configuration)
  • Added placeholder pages for planned packages (eol-core, eol-cli, eol-sdk)

βœ… Fixes

  • Pre-commit hooks now work correctly from root directory
  • Documentation validation runs from any location
  • Paths are consistent across the monorepo

Benefits

  • Single documentation site for entire framework
  • Better navigation between packages with unified structure
  • Pre-commit hooks work from any directory
  • Easier maintenance with single MkDocs config
  • Scalable structure for adding new packages

Testing

  • Documentation builds successfully: mkdocs build --strict
  • Documentation serves locally: mkdocs serve
  • Pre-commit hooks pass from root directory
  • All internal links work correctly

Screenshots

The documentation structure now looks like:

eol/
β”œβ”€β”€ mkdocs.yml              # Root-level config
β”œβ”€β”€ docs/                   # All documentation
β”‚   β”œβ”€β”€ packages/          # Package-specific docs
β”‚   β”‚   β”œβ”€β”€ eol-rag-context/
β”‚   β”‚   β”œβ”€β”€ eol-core/
β”‚   β”‚   └── eol-cli/
β”‚   β”œβ”€β”€ getting-started/   # Unified guides
β”‚   └── architecture/      # System docs
└── scripts/
    └── validate_docs.py   # Single validator

Next Steps

After merging this PR:

  1. Deploy to GitHub Pages with mkdocs gh-deploy
  2. Update CI/CD workflows to use new structure
  3. Remove old package-level MkDocs configs

πŸ€– Generated with Claude Code

eoln and others added 4 commits August 15, 2025 13:01
- Created root-level MkDocs configuration for entire monorepo
- Moved eol-rag-context docs to unified structure at docs/packages/
- Added comprehensive documentation for all packages (current and planned)
- Created landing pages for framework overview and package navigation
- Added root-level pre-commit hooks for documentation validation
- Moved validate_docs.py script to root scripts/ directory
- Fixed pre-commit hooks to work from root directory

Benefits:
- Single documentation site for entire framework
- Pre-commit hooks now work correctly from any directory
- Better navigation between packages
- Unified search across all documentation
- Easier maintenance with single MkDocs config

The documentation can now be built with 'mkdocs build' from root
and served locally with 'mkdocs serve'.

πŸ€– Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
- Added Mermaid.js from CDN for diagram rendering
- Created custom JavaScript for Mermaid initialization
- Added CSS styling for responsive diagrams
- Configured superfences extension for Mermaid code blocks
- Added light/dark mode support for diagrams

Now all Mermaid diagrams in markdown files will render as interactive
flowcharts, graphs, and sequence diagrams in the documentation.

πŸ€– Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
- Created new logo.svg with blue background and white text
- Created new favicon.svg with circular design
- Fixed paths in mkdocs.yml (removed 'docs/' prefix)
- Now logos are visible on both light and dark themes

The documentation now has proper branding with EOL logo.

πŸ€– Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
- Removed package-level .pre-commit-config.yaml (using root config)
- Removed package-level mkdocs.yml (using root config)
- Removed duplicate docs/ directory from package (using root docs/)
- Removed duplicate validate_docs.py script (using root script)
- Moved manage_docs_version.sh to root scripts/ directory

This completes the unified documentation migration by removing all
duplicate configuration files and documentation. Now there's a single
source of truth for:
- Pre-commit hooks configuration
- MkDocs documentation configuration
- Documentation content
- Validation scripts

πŸ€– Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
@eoln eoln merged commit b743a98 into feat/rag-context Aug 15, 2025
6 of 10 checks passed
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