Documentation Maintenance Checklist

Documentation notice

This documentation was generated with help from a large language model and has not been fully vetted by the developer. Verify critical details against the source code and current application behavior.

• Regenerate tutorial screenshots when UI visuals change.
• Check installation instructions for new dependency requirements.
• Update supported file formats and data-loading behavior.
• Verify calibration and pyFAI workflow instructions.
• Verify exported output descriptions (traces, peaks, poles, CIFs, simulations).
• Verify simulation workflow docs, presets, and cache behavior.
• Re-run mkdocs build before each tagged release.
• Verify README links still point to documentation and install sections.
• Verify GitHub Pages deployment URL and workflow status.
• Confirm follow-up PR branches compare against the intended base branch.