Generate comprehensive documentation for all 173 source units under doc/src/, covering kernel entry, x86 architecture, core libraries, drivers, services, and applications
Integrate mkdocs-material into the main Dockerfile and build pipeline (compile_docs.sh), replacing the previous pasdoc-based generation
Add mkdocs.yml with material theme, dark/light toggle, top navigation tabs (Home, Source, Compatibility, Toolchain, Planning), mermaid diagram support, and code copy buttons
Fill out documentation for compatibility shims (doc/compat/), LVGL headers (doc/lvglh/), and all toolchain scripts (doc/toolchain/)
Configure Drone CI to deploy the built site to nginx via trusted repo host volume mount
Pin mkdocs to >=1.6,<2 to avoid mkdocs 2.0 incompatibility with material theme
Tests Executed
Run docker compose build builder && docker compose run builder and verify documentation builds successfully
Serve site/ locally (npx serve site) and verify navigation tabs, sidebar, and mermaid diagrams render correctly
Verify Drone CI pipeline completes the deploy-docs step on a trusted runner
Spot-check a sample of generated doc pages against their source units for accuracy
# Summary
- Generate comprehensive documentation for all 173 source units under doc/src/, covering kernel entry, x86 architecture, core libraries, drivers, services, and applications
- Integrate mkdocs-material into the main Dockerfile and build pipeline (compile_docs.sh), replacing the previous pasdoc-based generation
- Add mkdocs.yml with material theme, dark/light toggle, top navigation tabs (Home, Source, Compatibility, Toolchain, Planning), mermaid diagram support, and code copy buttons
- Fill out documentation for compatibility shims (doc/compat/), LVGL headers (doc/lvglh/), and all toolchain scripts (doc/toolchain/)
- Configure Drone CI to deploy the built site to nginx via trusted repo host volume mount
- Pin mkdocs to >=1.6,<2 to avoid mkdocs 2.0 incompatibility with material theme
# Tests Executed
- Run docker compose build builder && docker compose run builder and verify documentation builds successfully
- Serve site/ locally (npx serve site) and verify navigation tabs, sidebar, and mermaid diagrams render correctly
- Verify Drone CI pipeline completes the deploy-docs step on a trusted runner
- Spot-check a sample of generated doc pages against their source units for accuracy
- Push feature branch & ensure DroneCI completes successfully
Generate comprehensive documentation for all 173 source units and
integrate mkdocs-material into the build toolchain. Documentation
covers kernel core, x86 architecture, drivers, applications, and
all subsystems with a tabbed navigation structure.
- Add mkdocs.yml with material theme, mermaid support, and tabbed nav
- Add doc/index.md landing page
- Generate doc/src/ markdown for every Pascal unit in src/
- Reorganize planning docs into doc/planning/
- Add compat, lvglh, and toolchain doc sections
- Update Dockerfile to install python3 and mkdocs-material (pinned <2)
- Replace pasdoc-based compile_docs.sh with mkdocs build --strict
- Add compile_docs.sh to the main build pipeline in compile.sh
- Add deploy-docs step in .drone.yml with host volume mount to nginx
- Add site/.gitkeep for build output directory
The Drone runner environment does not have `pip` or `mkdocs` on PATH
even when installed via the Docker image. Use `pip3` explicitly and
invoke mkdocs as `python3 -m mkdocs` to ensure reliable execution.
Also add --break-system-packages to the fallback install.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Aaron
Summary
Tests Executed