docs: add an index page for docs/
Your AI's guard dog to stop it from going rogue.
Brought to you by:
doberman
Originally created by: fu351
Originally owned by: navaneethsankar07
docs/ holds eight references — SETUP.md, CLI.md, REASON_CODES.md, PARITY.md, ADAPTER_GUIDE.md, BENCHMARKS.md, RELEASING.md, audit_otel.md — but no index. On GitHub the folder renders as a bare file list, so a newcomer has to open each file to learn what it covers.
What to do
docs/README.md: a short table or list with one line per doc — what it covers and who it's for (e.g. REASON_CODES.md — every reason code a BLOCK/AUTH can carry, for anyone reading a decision log).Markdown only, no Python, no build step. This is the page every future contributor lands on, so it earns its keep fast.
Originally posted by: navaneethsankar07
I’d like to work on this issue.
Originally posted by: fu351
Assigned, it's yours @navaneethsankar07. Good to see you back after the test-selection guide. One ask as you write the index: make each line say when you'd open that page, not what it's called. Someone landing on docs/ should be able to pick the right file from the description alone. If any page's purpose is unclear, ask here and I'll tell you what it's for.
Ticket changed by: fu351