Menu

#409 docs: add an index page for docs/

closed
nobody
2026-08-28
2026-08-18
Anonymous
No

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

  1. Add 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).
  2. Write the one-liners from each doc's own opening section; no need to read them deeply.
  3. If you spot anything odd while you're in there (a stale link, two docs covering the same ground), note it in the PR description rather than fixing it — surfacing it is the win.

Markdown only, no Python, no build step. This is the page every future contributor lands on, so it earns its keep fast.

Related

Tickets: #492
Tickets: #500

Discussion

  • Anonymous

    Anonymous - 2026-08-19

    Originally posted by: navaneethsankar07

    I’d like to work on this issue.

     
  • Anonymous

    Anonymous - 2026-08-20

    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.

     
  • Anonymous

    Anonymous - 2026-08-20
     
  • Anonymous

    Anonymous - 2026-08-28

    Ticket changed by: fu351

    • status: open --> closed
     

Log in to post a comment.