[Documentation] Update mcrogueface.github.io website #165

New issue

Closed

opened 2025-12-29 03:54:51 +00:00 by john · 1 comment

john commented

2025-12-29 03:54:51 +00:00

Owner

Summary

The website at https://mcrogueface.github.io/ exists but is out of date. It was generated from inline documentation but hasn't been refreshed recently.

Location

Repository: ~/Development/mcrogueface.github.io

Tasks

Regenerate API documentation from current inline docs
- Use tools/generate_dynamic_docs.py output
- Ensure all new classes (Line, Circle, Arc, etc.) are included
Update homepage content
- Current version number
- Download links to releases
- Screenshot of current state
Add tutorial section
- Link to or embed getting-started guide
- Progressive examples
Verify all links work
- Remove dead links
- Update any moved content

Generation Process

The site was largely auto-generated from inline documentation. The same tooling should work:

# In McRogueFace repo
./build/mcrogueface --headless --exec tools/generate_dynamic_docs.py

# Copy output to website repo
cp docs/api_reference_dynamic.html ../mcrogueface.github.io/

#164 - Version identity (website should show current version)
Tutorial demo game issue
README polish issue

## Summary The website at https://mcrogueface.github.io/ exists but is out of date. It was generated from inline documentation but hasn't been refreshed recently. ## Location Repository: `~/Development/mcrogueface.github.io` ## Tasks 1. **Regenerate API documentation** from current inline docs - Use `tools/generate_dynamic_docs.py` output - Ensure all new classes (Line, Circle, Arc, etc.) are included 2. **Update homepage content** - Current version number - Download links to releases - Screenshot of current state 3. **Add tutorial section** - Link to or embed getting-started guide - Progressive examples 4. **Verify all links work** - Remove dead links - Update any moved content ## Generation Process The site was largely auto-generated from inline documentation. The same tooling should work: ```bash # In McRogueFace repo ./build/mcrogueface --headless --exec tools/generate_dynamic_docs.py # Copy output to website repo cp docs/api_reference_dynamic.html ../mcrogueface.github.io/ ``` ## Related - #164 - Version identity (website should show current version) - Tutorial demo game issue - README polish issue