Pages Readme

Final Technical Report (MkDocs)

The report content is in technical_report/ and is rendered with MkDocs.

Local preview

uv run mkdocs serve

Open the local URL shown in terminal (usually http://127.0.0.1:8000).

Build static HTML

uv run mkdocs build --strict

Generated HTML files are written to site/.

Word count check (max 3000 words)

uv run python scripts/word_count_report.py

This counts words across all Markdown files in technical_report/.

GitHub Pages deployment

This repository includes .github/workflows/deploy-docs.yml to deploy MkDocs to GitHub Pages on push to main.

To enable it:

1. In GitHub repo settings, open Pages.
2. Set source to GitHub Actions.
3. Update mkdocs.yml values for:
   • site_url
   • repo_url
   • repo_name