documentation

To keep README and API documentation synchronized, apply documented update triggers to identify which files need edits, then update the relevant sections while preserving the prescribed structure and never editing auto-generated files by hand.

The best way to update Blockly documentation is to map the block definition changes to the required sections in BLOCKS.md, ensuring the manual documentation matches the current Blockly blocks without disrupting the existing file structure.

Documenting REST API and protocol changes requires updating HUBAPI.md and LUMP.md with the new endpoints or protocol notes, placing the information in the correct section for the right audience while maintaining the repository's required section order.

No, you should never edit auto-generated documentation files by hand. To maintain documentation accuracy for configuration guidance, only modify the manual source files and regenerate the automated outputs to keep them synchronized.

You need to update project documentation whenever user-facing hardware features like WiFi setup or gamepad support change. Use the change-to-doc mapping triggers to determine the exact files and sections requiring edits to avoid stale instructions.