mirror of
https://github.com/semantica-agi/semantica.git
synced 2026-09-12 04:01:35 +00:00
KaifAhmad1
727285171a
- Reorganize navigation structure (left sidebar: Home, Quickstart, Installation, Cookbook Recipes, Learning More, Deep Dive, API References) - Add TOC sections on homepage (Features, How to Read this Documentation, Resources) - Create new pages: learning-more.md, deep-dive.md, community-projects.md, citation.md, license.md - Add Mermaid diagrams for architecture, workflows, and concepts - Enhance all documentation pages with better code examples and explanations - Add custom CSS for modern aesthetic (docs/css/custom.css) - Update mkdocs.yml with Material theme, Mermaid support, and enhanced features - Improve user-friendly navigation and clear visual hierarchy - Add diagrams and charts throughout documentation
661 B
661 B
Testing Documentation Locally
Quick Start
Install Dependencies
pip install -r requirements-docs.txt
Run Local Server
mkdocs serve
Then visit: http://127.0.0.1:8000
Build Static Site
mkdocs build
Output will be in the site/ directory.
Development Workflow
- Make changes to
.mdfiles indocs/ - Run
mkdocs serveto preview - Check changes in browser
- Commit and push when ready
Troubleshooting
Port Already in Use
mkdocs serve -a 127.0.0.1:8001
Clear Cache
mkdocs build --clean
Check Configuration
mkdocs build --verbose