Skip to content

docs: README Loom-prep — reorder, fix tool counts, add Evidence Engine#25

Open
antnewman wants to merge 1 commit into
devfrom
docs/readme-loom-prep
Open

docs: README Loom-prep — reorder, fix tool counts, add Evidence Engine#25
antnewman wants to merge 1 commit into
devfrom
docs/readme-loom-prep

Conversation

@antnewman
Copy link
Copy Markdown
Owner

Summary

Documentation alignment ahead of the README's headline Loom video.

Changes

  1. Tool count consistency — fixed every reference that said "122" to "124" across README, CLAUDE.md, llms.txt, server.json. Includes the bookkeeping line in CLAUDE.md's "MCP Tool Count — Keep in Sync" section and the modules-table total in README.
  2. What it does, in 90 seconds — new section with a Loom-embed placeholder and three bullets. Replaces the implicit assumption that a reader will scroll to find what the platform does.
  3. Start here, rewritten as a two-step pair. Leads with `generate_premortem_questions` (works against zero data, returns instantly, produces share-worthy output) before `scan_for_red_flags` (which needs a project loaded). Three sample pre-mortem questions reproduced inline so value is visible above the fold.
  4. Built on PDA Platform — new section featuring Evidence Engine (Laura White's MPA Challenge 5 hackathon product) as a concrete adoption example.
  5. Section heading fix — "17 MCP Modules" → "18 MCP Modules".

What's NOT in this PR

  • No code, no tests. Pure docs.
  • No Loom embed yet — placeholder only. Replace once the video is recorded.

Test plan

  • Read top to bottom as a stranger; the workflow story should land in the first 30 seconds.
  • `grep -rn "122" README.md CLAUDE.md llms.txt server.json` returns nothing.
  • Branch 5 of 5 in the Loom-readiness fix series.

Five changes ahead of recording the README's headline Loom video:

1. **Tool count consistency.** The lede paragraph said "122 structured
   tools" while every other reference said 124. Fixed in README, CLAUDE.md
   ("currently **122**" bookkeeping line, monorepo intro, structure
   diagram), llms.txt ("122 structured MCP tools"), server.json
   description, and the README's MCP modules table total row.

2. **What it does, in 90 seconds** — new section between the live demo
   line and the personas table, with a placeholder for the Loom embed
   and three bullets describing what the video shows.

3. **Start here, rewritten as a two-step onboarding pair.** The old
   recommendation led with scan_for_red_flags, which requires a project
   loaded first. New version leads with generate_premortem_questions
   (works against zero data, returns sharp output instantly), with three
   sample questions reproduced inline so the value is visible before the
   reader commits to anything. scan_for_red_flags follows as the next
   call once data is loaded.

4. **Built on PDA Platform** — new section after the modules table,
   featuring Evidence Engine (Laura White's MPA Challenge 5 hackathon
   product, evidence-engine.netlify.app) as the first product built on
   the engine. Provides a concrete adoption proof point and an open
   invitation for others.

5. **Section heading correction.** "17 MCP Modules" was already stale —
   we have 18. Heading updated.

No code or test changes. Branch 5 of 5 in the Loom-readiness fix series.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant