docs: Restructure README around agent-output-quality framing#174
Open
jlevy wants to merge 6 commits into
Open
Conversation
Reframe the README to reflect how tbd works now: a managed-document system whose purpose is improving agent output quality via three levers — better knowledge, better processes (shortcuts + templates), and better task management — not just an issue tracker. - New arc: quality spine -> meta-skill surface -> three pillars (Knowledge/Shortcuts/Tasks, four artifacts incl templates) -> design principles (composable + attention-routing at scale; high-level not over-prescriptive; batteries-included-yet-forkable; git-native; scope) - Promote managed/forkable docs (tbd docs fork/update/add) to a named section instead of a footnote - Consolidate points said multiple times (yours-to-change, scope/ non-goals, agent-written) and trim historical asides, the coordination-tools list, and the frozen tbd-list dump - Fix stale counts: 25+ guidelines, 30+ shortcuts, 4 templates; add the missing guideline rows and lead with the load-first set https://claude.ai/code/session_01RDZ8fshcw3u6tqQywZBTPB
Replace all em dashes with commas, colons, semicolons, or parentheses as appropriate, enforcing the strict no-em-dash punctuation adopted upstream. Keeps the restructured content; only punctuation changes. https://claude.ai/code/session_01RDZ8fshcw3u6tqQywZBTPB
 |
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| Secrets |  |
Jun 13, 2026 7:08p.m. | Review ↗ |
Important
AI Review is run only on demand for your team. We're only showing results of static analysis review right now. To trigger AI Review, comment @deepsourcebot review on this thread.
Coverage Report for packages/tbd
File CoverageNo changed files found. |
- Lead with a concrete value prop: a drop-in meta-skill that helps any coding agent ship higher-quality, slop-free code - Broaden the problem statement beyond memory loss to recurring poor engineering and process drift that degrade a repo over time - Replace the generic "Knowledge/Processes/Tasks (what to know...)" pillar labels with concrete ones: Engineering knowledge (naming the tech covered: TypeScript, Python, TDD, golden testing, Convex), Spec-driven processes, Disciplined task tracking - Note that guidelines are easy to add and, once in tbd, get applied systematically rather than pasted into prompts https://claude.ai/code/session_01RDZ8fshcw3u6tqQywZBTPB
- Tagline: "helps you and your coding agents" (not just the agent) - Rewrite the usage paragraph to convey that tbd is strictly additive: it routes agents to extra knowledge and task tracking when relevant without overly constraining them https://claude.ai/code/session_01RDZ8fshcw3u6tqQywZBTPB
- Rename the processes pillar to "Specs, planning, and code review processes" to name what it covers - Credit the idea as borrowed from Beads, and note tbd beads are plain Markdown files with YAML frontmatter, more transparent and less glitchy than bd's SQLite database https://claude.ai/code/session_01RDZ8fshcw3u6tqQywZBTPB
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the README to reflect how
tbdworks now: not just an issue tracker, but a managed-document system whose purpose is improving the quality of agent output via three levers, better knowledge, better processes, and better task management.The previous README led with beads as "the" feature and treated specs, guidelines, and shortcuts as add-ons. This restructures around a clearer arc.
New arc
tbd's own docs.Cleanup
tbd docs fork/update/add) from a footnote to a named section.tbd listdump.Diff is README-only. Work tracked under bead epic
tbd-5c33.https://claude.ai/code/session_01RDZ8fshcw3u6tqQywZBTPB