Documentation TODO — What Still Needs Writing

This file tracks documentation gaps and improvement ideas. It serves as both a roadmap and a reminder that documentation, like software, is never truly finished.

High Priority

Task Status Notes
wxPython control tag reference Pending Document all % wx_* control tags with parameter tables
Plugin system API Pending The plugin system needs complete API documentation
Mobile (Kivy) development guide Pending Dedicated guide for Android/Kivy development
C/Nim/Zig integration tutorial Pending Step-by-step for compiled extensions

Medium Priority

Task Status Notes
Complete schdata_* module documentation Partially done Several _schdata_* files need content
OAuth provider setup guide Pending Detailed configuration walkthrough
Deployment cookbook Pending Recipes for AWS, Hetzner, DigitalOcean
Performance tuning guide Pending Profiling, optimization techniques
Testing guide Pending Unit tests, integration tests, test data

Low Priority

Task Status Notes
Video tutorials storyboard Pending Outline for 5-minute video tutorials
API reference cross-linking In progress Add cross-references between API docs and guides
Changelog format standardization Pending Adopt Keep a Changelog format
Contributor guide Pending How to contribute to Pytigon

Documentation Style Guidelines

For contributors adding documentation:

  1. Use .ihtml syntax for the extended markdown — lines starting with % are special
  2. Write for both audiences — The developer who knows Django AND the newcomer
  3. Show, don't just tell — Every concept should have a code example
  4. Cross-reference aggressively — Link to related topics using Topic syntax
  5. Keep it technical but human — Documentation that reads like a textbook nobody reads. Documentation that reads like a conversation, people remember.

How to Mark a Task Complete

Replace Pending or In progress with Completed and add the date. Move completed items to a "Recently Completed" section below.

?: Documentaction ?: Documentaction