Skip to content

docs: fix typos, unclear phrasing, and terminology drift - #476

Merged
hongyi-chen merged 7 commits into
mainfrom
docs/fix-typos-tone-terminology-sweep
Aug 5, 2026
Merged

docs: fix typos, unclear phrasing, and terminology drift#476
hongyi-chen merged 7 commits into
mainfrom
docs/fix-typos-tone-terminology-sweep

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Repo-wide sweep of the documentation content for quality issues, using AGENTS.md as 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_lint skill, codespell, and targeted scans for duplicated words, broken punctuation, hedging language, and deprecated terminology.

Changes

1. Typos, spelling, and mechanics

  • Corrected incorrect articles: a SSH hostan SSH host, a MCPan MCP server (privacy.mdx, mcp.mdx).
  • Fixed external product names: Iterm/itermiTerm2, WeztermWezTerm, Voice OverVoiceOver, GithubGitHub.
  • Fixed Non exhaustiveNon-exhaustive and Tab relatedtab-related.
  • Removed stray spaces before punctuation (**Permissions** ., `ESC` .) and fixed the image-format list in images-as-context style pages.
  • Fixed a comma splice in the Prompt Suggestions note and a missing sentence period in the Warp Drive web preference step.
  • Fixed three sentence fragments in login troubleshooting and known issues (for example, ...when you click "Sign up" or "Sign in". Please go to... → a single complete sentence).

2. Awkward or unclear messaging

  • Removed please from instructional and cross-reference sentences (please seesee, please refer tosee, Please note thatNote that). Politeness in support/contact sentences and inside example prompts was left untouched.
  • Replaced may with can for optional actions, per the guide's preference (You may also use your mouseYou can also use your mouse, you may emailyou can email).
  • Removed hedging and nominalized phrasing: you should be able to understandyou can understand, you are able to clickyou can click, You may be able to remediate this error by...To remediate this error, try....
  • Removed dismissive simply from shell setup, Code overview, git worktrees, and accessibility instructions.
  • Rewrote three ungrammatical or vague sentences on the accessibility page (...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...).
  • Tightened one telemetry description that repeated itself (Agent Mode used and cited external sources that were used in its response).

3. Tone and terminology drift

  • Applied feature-name casing per the glossary: agent modeAgent Mode, command paletteCommand Palette, codebase contextCodebase Context, git repositoriesGit repositories. Most instances are in the telemetry tables in privacy.mdx and in changelog entries.
  • Replaced the internal name Agent Modality with Terminal and Agent modes.
  • Replaced ambient agent with cloud agent in telemetry descriptions (event names such as AmbientAgent.DispatchFailed and CLI.Execute.Agent.RunAmbient are unchanged).
  • Replaced Oz agent/Oz agents with agent/agents in the software factory guides.
  • Corrected two title-case headings to sentence case (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.
  • MacOS in /Applications/Warp.app/Contents/MacOS/stable — a literal path inside the app bundle.
  • agent mode / shell mode in 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.
  • sorce in Command Corrections — an intentional example of a misspelled command being corrected.
  • Keyboard-shortcut formatting, image alt text, and screenshot widths — pre-existing lint findings outside the scope of this sweep.

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 --allproduct-casing dropped from 41 to 12 (remaining are the false positives listed above) and oz-term from 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.

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]>
@cla-bot cla-bot Bot added the cla-signed label Aug 5, 2026
@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 5, 2026 10:52pm

Request Review

@hongyi-chen
hongyi-chen marked this pull request as ready for review August 5, 2026 19:26
@oz-for-oss

oz-for-oss Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

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 /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@rachaelrenk
rachaelrenk self-requested a review August 5, 2026 19:31
Comment thread src/content/docs/terminal/appearance/prompt.mdx Outdated
Comment thread src/content/docs/terminal/more-features/accessibility.mdx Outdated
Comment thread src/content/docs/agents/getting-started/faqs.mdx Outdated
rachaelrenk

This comment was marked as outdated.

@rachaelrenk
rachaelrenk self-requested a review August 5, 2026 19:56

@rachaelrenk rachaelrenk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

hongyi-chen and others added 2 commits August 5, 2026 22:43
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]>

Copy link
Copy Markdown
Collaborator Author

Merge conflicts resolved

Merged main into this branch. Both conflicts were the same terminology change resolved two different ways:

File This branch main (#481) Resolution
run-a-software-factory-in-the-cloud.mdx Oz agent workersagent workers Oz agent workerscloud agent workers took main
set-up-a-software-factory.mdx triggering Oz agentstriggering agents triggering Oz agentstriggering cloud agents took main

Both branches were removing the Oz agent prefix flagged by the terminology glossary; #481 just landed the more specific wording first. This branch's edits to those two files were fully superseded, so after the merge both guides match origin/main byte-for-byte.

Additional fix: telemetry generator was left out of sync

This PR renames ### Exhaustive Telemetry Table### Exhaustive telemetry table in privacy.mdx (correct per the sentence-case heading rule), but .agents/skills/release_updates/scripts/update_telemetry.py matched that heading as a literal string to find where the generated table begins:

marker = "\n### Exhaustive Telemetry Table"
index = content.find(marker)
if index == -1:
    return content.rstrip() + "\n"   # whole file becomes "intro"

With the rename, find() returns -1, so the next weekly release run would treat all 1321 lines as intro and append a third full copy of the ~625-row telemetry table. Verified against the branch:

PR branch:   marker found at index: -1   -> intro = 1321 lines (entire file)
origin/main: marker found at index: 58017 -> intro = 694 lines

Fixed by hoisting 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.

As a bonus, this also self-heals a pre-existing duplicate: privacy.mdx on main already contains two telemetry tables (lines 70 and 696) — the first got sentence-cased by an earlier sweep, which broke the marker once before and caused the generator to append a second table. With the marker now matching the first heading, the next release run truncates there and emits a single table:

intro lines kept: 67
headings in regenerated file: ['### Exhaustive telemetry table']
duplicate table removed: True

Validation

  • npm run build — 364 pages, no errors.
  • python3 -m py_compile update_telemetry.py — passes.
  • style_lint --changed — 167 issues across the 39 touched files, but only 5 fall on lines this PR changed, and all 5 are pre-existing bolded settings-path terms (**Active AI**, **Prompt Suggestions**, **Next Command**, **Privacy**, **Classic**) that are byte-identical to main. No new violations introduced.

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.

@hongyi-chen
hongyi-chen merged commit c507cba into main Aug 5, 2026
8 checks passed
@hongyi-chen
hongyi-chen deleted the docs/fix-typos-tone-terminology-sweep branch August 5, 2026 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants