Repository navigation
docs: rewrite documentation in plain English - #135
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.
Summary
Rewrite 92 documentation files in plain English with shorter sentences and no prose em dashes or en dashes. Keep ADRs and the shipped skill focused on agent instructions.
Apply Humanizer, Simple English, and Technical Writing without installing them. Use
writing-for-agentsfor ADRs and the shipped skill. Leave.agents/,docs/agents/, andAGENTS.mdunchanged.Evidence
After: Zero. All 113 code blocks, link targets, and heading anchors are unchanged.
After: Direct steps and shorter explanations.
vp run --no-cache docs-buildpasses the excerpt checks, Astro checks, site build, and internal links.vp run --no-cache api-typespasses with TypeScript 7 and 5.9.After: The domain map and coverage record reflect this rewrite.
vp exec intent maintainer checkreports no pending items.vp run skills-check,vp run --no-cache format, andgit diff --checkpass.Merge Danger
Door: two-way
The documentation commit can be reverted. No Changeset is required for this documentation-only change.
Blast Radius: Documentation
Readers and agents receive revised wording. Runtime behavior, public types, executable examples, and dependency ranges are unchanged.