Description
Documentation Upgrade to MkDocs
I was trying to search for the PR template on the Curio GitHub and realized the docs right now are pretty scattered and unsearchable. So, I spent the weekend working on a complete documentation overhaul. Followed design cues from UrbanMapper to create a cohesive ecosystem experience.
Live Demo
https://makaveli2P.github.io/curio/
Changes
Upgraded Curio's documentation from basic markdown files to a MkDocs structure:
- Organized Structure: Getting Started, Examples (11 tutorials), User Guide, Contributing sections.
- Material Design Theme: Built-in search, responsive interface, smart navigation.
- Auto-deployment: GitHub Actions workflow ready for
urban-toolkit.github.io/curio/
Technical Implementation
- MkDocs + Material theme (Python ecosystem standard)
- More Details:
documentation-upgrade-mkdocson my fork.
I'm raising this issue for feedback before submitting the formal PR and can change anything in the docs based on the input. I'd appreciate any thoughts on: content organization, theme, GitHub Actions for deployment, and any missing/unnecessary sections. I'm ready with a PR to move these live docs to urban-toolkit.github.io/curio/ - the implementation is complete and tested, just need direction on adjustments if needed.