Documenting A Feature

When a feature changes how people deploy, configure, operate, or contribute to Blackbox, update the docs in the same change.

Common Places To Update

• Getting Started when the initial setup changes
• Deployment when topology or proxy guidance changes
• Configuration when environment variables change
• Data Sources when source behavior changes
• Contributing when developer workflows change

Keep Docs Task-Oriented

Prefer:

• "How do I deploy this?"
• "What do I set?"
• "Why does this fail?"

Over:

• Long changelog-style descriptions with no clear operator task