MadROM Documentation Hub
This hub collects the hand-curated articles that power the MadROM documentation site. Each guide cites the relevant engine sources so maintainers know where to confirm behaviour before editing, while the navigation keeps the public view focused on high-level information.
Layout
- Published docs appear in the navigation menu and cross-link to companion articles such as the Known Issues log.
- Archival copies are retained offline so staff can diff historic prose against the current guidance without exposing the staging materials.
Refreshing content
- Open the referenced game source files (for example
src/fight.c
for melee maths) and confirm the mechanics still match the prose. - Update the HTML file in place. When replacing an older write-up, archive the previous version privately so the history stays trackable.
- Note any outstanding mismatches between code and documentation in Known Issues to help prioritise engine fixes.
Related tooling
Helper scripts such as render_docs.py
and itemstats_report.py
remain available to staff for data
extraction and verification. These utilities are not part of the public site build, but they complement the
documentation when deeper analysis is required.