add documentation

This commit is contained in:
Osman Mehmood
2026-03-31 15:38:58 +05:00
parent b7a82da0be
commit 9024f81eb7
32 changed files with 941 additions and 2 deletions

8
docs/README.md Normal file
View File

@@ -0,0 +1,8 @@
# Documentation
The **MkDocs site** (for GitHub Pages) lives in **`docs-site/`**.
- Source pages: `docs-site/docs/`
- Local preview: `cd docs-site && python3 -m venv .venv && source .venv/bin/activate && pip install -r requirements.txt && mkdocs serve`
The file **`directory-structure.md`** in this folder remains a quick `src/` layout reference duplicated in the site under **Appendix → Directory structure**.