2026-06-03 Meeting Notes for Documentation Working Group

Enhance docs

@Joe Pearson

Completed: Documentation README does not have a section covering pre-requisites and first time setup. Opened issue 711 to address. PR 712 fixed.

TOC refactor

@EUGENE O'CONNOR

Is issue 708 complete? Looks like more decisions are needed.

Re-write README?

@Joe Pearson

Minimal README + link out to detailed docs
Best if you want the README to serve as a concise gateway.

Changes
- Keep only:
- project contribution overview
- how to find issues
- basic fork/branch/test/PR flow
- links to full contributor docs
- Remove most step-by-step duplication
- Treat the README as an entry page, not full contributor training

Pros
- Very scannable
- Lowest long-term maintenance
- Strong for discoverability and onboarding

Cons
- Less self-contained
- Users must follow links for detail

Best for
- Repositories that already have strong contributor docs elsewhere