M4.3 Documentation polish (15-minute new-developer test) #49

Open
opened 2026-04-08 23:24:36 +00:00 by claude-code · 0 comments
Collaborator

Phase 4 — Hardening, milestone 3.

Goal

A new developer can clone the repo, set up keys, and complete their first successful research call in 15 minutes — without having to read source.

Scope

  • Update DevelopmentGuide with current make install flow, Tavily / Anthropic setup, and test commands
  • Update UserGuide Troubleshooting section with anything new from M3.x stress tests
  • README.md "Quick start" section gets a 5-line happy path
  • Add a Troubleshooting wiki page covering: stale install on $PATH, missing API keys, model id 404s, budget confusion, synthesis failures
  • Optional: a one-page architecture diagram (can be ASCII / Mermaid)

Deliverable

  • The 15-minute test, performed by literally timing it (or asking a friend)
  • Wiki and README changes pushed
Phase 4 — Hardening, milestone 3. ## Goal A new developer can clone the repo, set up keys, and complete their first successful research call in 15 minutes — without having to read source. ## Scope - Update [DevelopmentGuide](https://forgejo.labbity.unbiasedgeek.com/archeious/marchwarden/wiki/DevelopmentGuide) with current `make install` flow, Tavily / Anthropic setup, and test commands - Update [UserGuide](https://forgejo.labbity.unbiasedgeek.com/archeious/marchwarden/wiki/UserGuide) Troubleshooting section with anything new from M3.x stress tests - README.md "Quick start" section gets a 5-line happy path - Add a Troubleshooting wiki page covering: stale install on `$PATH`, missing API keys, model id 404s, budget confusion, synthesis failures - Optional: a one-page architecture diagram (can be ASCII / Mermaid) ## Deliverable - The 15-minute test, performed by literally timing it (or asking a friend) - Wiki and README changes pushed
archeious added this to the Phase 4: Hardening milestone 2026-04-08 23:25:13 +00:00
Sign in to join this conversation.
No labels
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: archeious/marchwarden#49
No description provided.