add documentation
This commit is contained in:
8
docs/README.md
Normal file
8
docs/README.md
Normal 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**.
|
||||
Reference in New Issue
Block a user