Docs Maintenance

Docs Maintenance

Principles

• The wiki is a curated version of the docs.
• The main repo is the canonical source for long or frequently changing content.

When to update the wiki

• CLI behavior/flags changed: update CLI Reference and any impacted pages
• Defaults/config schema changed: update Configuration & Templates and Config Resolution
• Indicator columns changed: update Indicators (Overview), Data Shape Invariants, and the relevant indicator page
• source_data / Yahoo column handling changed: update Source Data Deep Dive
• Write path or async writers changed: update Write Output Deep Dive and Output Writing
• Tests/profiling updated: update Developer Guide and Profiling

Suggested review checklist (PRs)

• If src/cli.py changed, does the wiki reflect option/behavior changes?
• If src/indicators.py or src/default_configs.json changed, are indicator columns/config keys still correct?
• If profiling/ changed, are profiling commands/artifacts still accurate?
• If tests/ changed, are the documented test commands still accurate?

Related pages:

• Developer Guide
• CLI Reference