feat(whiteboard): add docs write-back mode - #11
Merged
Merged
Conversation
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
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.
Adds
/whiteboard docs, which carries what a map learned back into the repo's own docs as a reviewable branch.What it does
stale-doc,undocumented, andconfusingfriction,[stated]rationale,unexplaineddecisions, andrefutedsuspected bugs.docs/, AGENTS.md/CLAUDE.md, and code comments/docstrings. It follows existing repo docs conventions and never proposes code renames. ADR-shaped items are handed off by wording ("candidates for decision records (ADRs)"), with a design-decisions doc as the fallback..map/scout.md) → propose changes in chat, grouped by file, and the user picks → write in agit worktreebranch as two commits (docs, then comments-only) → show the diff stat and push/open a PR only on an explicit yes.[inferred]rationale never goes into repo docs. PR evidence cites code receipts and commits, never map paths.proposed: <branch>. On the next/whiteboardor refresh, landed changes remove the entry and upgrade evidence to[documented: <path>]; abandoned branches reopen it.Other whiteboard changes
docsas the only, narrowly scoped exception.stale-docandundocumented.inconsistentnow covers only "two patterns doing the same job".Checks
Ran locally:
npm run format:check,npm run validate, andnpm run sync(mirror underskills/included).