Skip to content

docs: slim README + per-framework wiki guides#9

Merged
arnav2 merged 4 commits into
mainfrom
docs/slim-readme-framework-guides
Apr 29, 2026
Merged

docs: slim README + per-framework wiki guides#9
arnav2 merged 4 commits into
mainfrom
docs/slim-readme-framework-guides

Conversation

@arnav2
Copy link
Copy Markdown
Contributor

@arnav2 arnav2 commented Apr 29, 2026

Summary

  • Slim README from 609 → 148 lines: cover/index page with vertical jump-nav, tag chips that link to GitHub code search, framework badges that deep-link into the wiki.
  • New wiki pages: Overview (mental model), Quickstart (5-min path), Frameworks hub.
  • New per-framework guides under docs/wiki/frameworks/ — each ports the same flagship (credit_memo_drafter) end-to-end so devs can compare runtimes side-by-side:
    • pydantic-ai (reference impl)
    • LangChain (ReAct + langchain-mcp-adapters)
    • LangGraph (explicit retrieve → draft → review graph)
    • CrewAI (3-agent crew with per-role permission scoping)
    • OpenAI Agents SDK (native MCP + output guardrail)
    • Temporal (durable workflows, replay-safe activities)
    • Claude Desktop & Cursor (no-code MCP config)
    • Custom MCP (raw mcp SDK + Streamable HTTP for Node/Go/serverless)
  • Hub page calls out the universal contract (5 rules every runtime must honor) and a port-a-flagship recipe showing schema + prompt are framework-agnostic.

Test plan

  • Render README on GitHub; confirm vertical jump-nav anchors land correctly.
  • Spot-check tag chip links open GitHub code search for that tag.
  • Open each docs/wiki/frameworks/*.md page and confirm internal links resolve.
  • Verify framework badge links in README open the per-framework wiki page (not the hub).
  • Confirm docs/wiki/README.md index lists all eight per-framework pages.

🤖 Generated with Claude Code

- README cut from 609 → 148 lines: index, vertical jump-nav, tag chips
  linking to GitHub code search, framework badges deep-link to wiki.
- New wiki pages: overview, quickstart, frameworks hub.
- New per-framework guides under docs/wiki/frameworks/ — pydantic-ai,
  LangChain, LangGraph, CrewAI, OpenAI Agents SDK, Temporal,
  Claude Desktop & Cursor, Custom MCP. Each ports the credit_memo_drafter
  flagship end-to-end so devs can compare runtimes side-by-side.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@arnav2 arnav2 requested a review from a team as a code owner April 29, 2026 00:54
arnav2 and others added 3 commits April 28, 2026 20:56
Replace "staging" wording with "self-hosted" / "multiple tenants" in
the wiki pages introduced by this branch.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Add scripts/build_wiki_book.py to generate docs/wiki/book/ from every
  flagships/*/README.md and recipes/*/README.md. Source READMEs remain
  authoritative; re-run the script after edits.
- Flagship book is grouped by vertical (banking, legal, accounting,
  healthcare, insurance, real-estate, sales, hr, engineering, government,
  other) — 44 flagships across 11 chapters.
- Recipe book is alphabetized into A-D / E-H / I-L / M-P / Q-T / U-Z
  chapters — 105 recipes inline.
- Heading levels are demoted on inclusion so the book reads as one
  continuous document.
- Wire the book into both the README index and docs/wiki/README.md so
  every example is readable from the wiki without leaving it.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Tags now live in PEP 621 [project] keywords on every flagship's
  pyproject.toml — single source of truth, no more duplicated lists.
- scripts/sync_flagship_tags.py keeps the per-flagship keywords in sync
  with a manifest; --check fails CI on stale or missing tags.
- All 44 flagships now declare keywords (was: 32 had ad-hoc README
  Tags: lines, 12 had nothing).
- scripts/build_wiki_book.py reads keywords and:
  • renders Tags chips on each flagship chapter, deep-linked to the
    tag index
  • emits docs/wiki/book/flagships-by-tag.md — full tag cloud +
    per-tag flagship list with anchors into the book chapters
- README "Browse by tag" repointed from GitHub code search to the
  new structured wiki tag index.
- docs/wiki/writing-a-flagship.md adds a Tagging section documenting
  the keywords convention (first tag = primary vertical, 2-5 total,
  reuse existing taxonomy).
- Makefile gains 'make tags' (sync + regenerate) and 'make tags-check'.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@arnav2 arnav2 merged commit 5d55756 into main Apr 29, 2026
0 of 2 checks passed
@arnav2 arnav2 deleted the docs/slim-readme-framework-guides branch April 29, 2026 01:15
arnav2 added a commit that referenced this pull request Apr 29, 2026
Resolves the 16 ruff lint failures CI raised on PR #9 — 15 I001 import
sort fixes (auto-fixed) and 1 F841 unused local in scripts/bulk_verify_recipes.py.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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