docs: fix typos, unclear phrasing, and terminology drift - #476
Conversation
Sweep of all documentation content for quality issues, applying only fixes that were clearly wrong or inconsistent with AGENTS.md. No pages were restructured and no content meaning was changed. Typos and mechanics: - Corrected "a SSH host", "a MCP", "Iterm"/"iterm", "Wezterm", "Voice Over", and "Non exhaustive". - Fixed stray spaces before punctuation, a comma splice, a missing sentence period, and three sentence fragments in login and known-issues troubleshooting. Tone and clarity: - Removed "please" from instructional and cross-reference sentences. - Replaced "may" with "can" for optional actions, and dropped hedging such as "you should be able to", "you are able to", and "you may be able to". - Removed dismissive "simply" and rewrote three ungrammatical or vague sentences on the accessibility page. Terminology: - Applied "Agent Mode", "Command Palette", "Codebase Context", and "Git repositories" casing in telemetry tables and changelog entries. - Replaced the internal name "Agent Modality" with "Terminal and Agent modes", "ambient agent" with "cloud agent", and "Oz agent(s)" with "agent(s)". - Corrected two title-case headings to sentence case. Validated with `npm run build` (364 pages), the internal link checker (3443 links, 0 broken), and the style_lint skill. Co-Authored-By: Oz <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
There was a problem hiding this comment.
Overview
This PR performs a documentation-wide copy-edit sweep for typos, punctuation, tone, and terminology consistency. I reviewed the attached annotated diff, PR description, and spec context; no approved spec context was present, and the diff does not introduce code or configuration with security impact.
Concerns
- No blocking correctness, documentation-structure, link, or security concerns found in the attached diff.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
Resolve conflicts in software factory guides by taking main's canonical terminology from #481 ('cloud agent workers', 'triggering cloud agents'), which supersedes this branch's removal of the 'Oz agent' prefix. Co-Authored-By: Warp Agent <[email protected]>
The telemetry table heading in privacy.mdx was renamed to sentence case to follow the style guide, but update_telemetry.py matched the old title-case heading as a literal string to locate the generated section. With no match, _extract_intro() treats the entire file as intro and appends another full copy of the ~625-row table on the next release run. Hoist the heading into a single TELEMETRY_TABLE_HEADING constant used for both the marker and the emitted heading, so the two can't drift again. This also lets the next run truncate at the first heading and collapse the duplicate table that already exists in privacy.mdx. Co-Authored-By: Warp Agent <[email protected]>
Merge conflicts resolvedMerged
Both branches were removing the Additional fix: telemetry generator was left out of syncThis PR renames marker = "\n### Exhaustive Telemetry Table"
index = content.find(marker)
if index == -1:
return content.rstrip() + "\n" # whole file becomes "intro"With the rename, Fixed by hoisting the heading into a single As a bonus, this also self-heals a pre-existing duplicate: Validation
I could not submit a formal approval — this token authenticates as @hongyi-chen, the PR author, and GitHub blocks self-approval. The existing approval from @rachaelrenk is still active and was not dismissed by these pushes. This comment was generated with Oz. |
Summary
Repo-wide sweep of the documentation content for quality issues, using
AGENTS.mdas the reference. Every change is either a clear error or a clear inconsistency with the style guide. No pages were restructured, no content was added, and no meaning was changed.Detection used the
style_lintskill,codespell, and targeted scans for duplicated words, broken punctuation, hedging language, and deprecated terminology.Changes
1. Typos, spelling, and mechanics
a SSH host→an SSH host,a MCP→an MCP server(privacy.mdx,mcp.mdx).Iterm/iterm→iTerm2,Wezterm→WezTerm,Voice Over→VoiceOver,Github→GitHub.Non exhaustive→Non-exhaustiveandTab related→tab-related.**Permissions** .,`ESC` .) and fixed the image-format list inimages-as-contextstyle pages....when you click "Sign up" or "Sign in". Please go to...→ a single complete sentence).2. Awkward or unclear messaging
pleasefrom instructional and cross-reference sentences (please see→see,please refer to→see,Please note that→Note that). Politeness in support/contact sentences and inside example prompts was left untouched.maywithcanfor optional actions, per the guide's preference (You may also use your mouse→You can also use your mouse,you may email→you can email).you should be able to understand→you can understand,you are able to click→you can click,You may be able to remediate this error by...→To remediate this error, try....simplyfrom shell setup, Code overview, git worktrees, and accessibility instructions....easily check what was the command...,Warp announces stuff on its own,In short - it's related to how our UI Framework is currently implemented and that as of now...).Agent Mode used and cited external sources that were used in its response).3. Tone and terminology drift
agent mode→Agent Mode,command palette→Command Palette,codebase context→Codebase Context,git repositories→Git repositories. Most instances are in the telemetry tables inprivacy.mdxand in changelog entries.Agent ModalitywithTerminal and Agent modes.ambient agentwithcloud agentin telemetry descriptions (event names such asAmbientAgent.DispatchFailedandCLI.Execute.Agent.RunAmbientare unchanged).Oz agent/Oz agentswithagent/agentsin the software factory guides.Exhaustive Telemetry Table,Launch Configuration YAML Format).Deliberately not changed
blocklist/Blocklist— these refer to Warp's terminal block list UI, not a denylist, so the lint hits are false positives.MacOSin/Applications/Warp.app/Contents/MacOS/stable— a literal path inside the app bundle.agent mode/shell modein the CLI docs — the CLI's two input modes are consistently lowercase as a pair on those pages.AI credits— this is one of the three documented credit buckets (AI, compute, platform), not the deprecated "AI credits" phrasing.sorcein Command Corrections — an intentional example of a misspelled command being corrected.Validation
npm run build— 364 pages built, no errors.python3 .agents/skills/check_for_broken_links/check_links.py --internal-only— 3443 internal links, 0 broken.python3 .agents/skills/style_lint/style_lint.py --all—product-casingdropped from 41 to 12 (remaining are the false positives listed above) andoz-termfrom 10 to 0, with no new findings in any category.Note on the source repo
This sweep was originally requested against
warpdotdev/gitbook, which is now archived and read-only, so the same fixes were applied to the corresponding pages in this repo.Co-Authored-By: Oz [email protected]
Conversation: https://app.warp.dev/conversation/b801d751-24ee-4934-bece-a59c70b4b0a3
Run: https://oz.warp.dev/runs/019fd126-b20a-7318-80a3-cc7d72c87f37
This PR was generated with Oz.