Repository navigation
Conversation
This was referenced Jun 8, 2026
…ding()-precision + #548 link [skip ci]
…i-design [skip ci]
ivogt
force-pushed
the
docs/warm-voice-why-docs
branch
from
June 9, 2026 05:33
013ccf4 to
d97b263
Compare
Collaborator
Author
|
Rebased onto main (which now has #553's streaming Resolved
Net: warm onboarding voice + accurate post-#553 contract. Branch is now CLEAN on main. Still |
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.
What
Warms the 9 strong "why"/explanation docs into the onboarding voice (AGENTS.md "Documentation voice"; exemplar: the matching doc from #547). Docs-only,
[skip ci].rendered-barrier,why-web-streams-everywhere,why-includes-is-sync,file-name-conflict-warnings,context-api,api-boundary-policy.execution-model,manifests,use-cache-api-design.Every fact, file ref, identifier, table, code block, and number is preserved — these are reference docs, so warmth goes in the prose around the facts, never instead of them.
How (and a lesson worth recording)
I first tried fanning this out to agents with an adversarial fidelity verifier. The verifier earned its keep: 7 of 9 agent rewrites invented content — fabricated rationale, a made-up "stays in lockstep" cross-reference in
execution-model, a dropped "unrelated" qualifier inapi-boundary-policy, and a three→four miscount of caching mechanisms inuse-cache. The "lead with the why" instruction is the trap: when the source doesn't state a rationale, an agent confidently manufactures one.So I reverted all 7 and hand-authored these, self-checking each against the original. No agent touched doc prose. (Recorded the lesson in AGENTS.md already.)
Accuracy fixes found along the way
rendered-barrier: "non-streaming only" reframed to the concrete trigger — unavailable when the matched route tree usesloading()(which is exactly what the guard's error message says atloader-resolution.ts:316). The streaming follow-up is now tracked in feat(router): support ctx.rendered() on streaming (loading()) route trees #548 and linked from the doc.file-name-conflict-warnings: reconciled an internal inconsistency — the TL;DR said "two bugs" while the body enumerates three.context-api:ctx.varremoval is correctly labeled decided, not "unsettled" (an error the agent draft made).Test plan
formatclean; pre-commit hook green.[skip ci]per the docs convention.Follow-ups (not in this PR)
archive/vs delete decision.