Introducing mkdocs-editor-notes: Keep Your Documentation Clean While Tracking TODOs
TLDR
Track TODOs right in your docs without cluttering them. Use footnote syntax, get an auto-generated tracker page.
Writing documentation is hard. Keeping it up-to-date is even harder. When I'm writing, I inevitably encounter sections that need more work:
- I should add an example here
- Need to verify this with the team
- TODO: Update this after the API changes
- Does this make sense to beginners?
These thoughts are valuable—they represent improvements, questions, and reminders that will make documentation better. But where do you put them?
