docs: deep polish across all sections (typos, terminology, formatting)#189
Open
hongyi-chen wants to merge 5 commits into
Open
docs: deep polish across all sections (typos, terminology, formatting)#189hongyi-chen wants to merge 5 commits into
hongyi-chen wants to merge 5 commits into
Conversation
Co-Authored-By: Oz <oz-agent@warp.dev>
…changelog
Meaning-preserving copyedit across owned docs directories:
- Headers to sentence case (preserving proper feature names: Agent Mode,
Codebase Context, Command Palette, Warp Drive, Code Review, Skills, etc.)
- Settings paths normalized to **Settings** > **X** (arrows -> bold + >)
- Keyboard shortcuts in backticks with + separator (Cmd+I, Ctrl+Shift+P);
fixed ALL-CAPS combos (CTRL+SHIFT+C -> Ctrl+Shift+C)
- Terminology: agent-mode -> Agent Mode, Mac -> macOS, Github -> GitHub,
ambient agent -> cloud agent, blocklist -> denylist, Secret Reduction ->
Secret Redaction, codebase context -> Codebase Context
- UI buttons bolded (Apply Changes, Fast-Forward, Save)
- Raw-URL link anchors replaced with descriptive link text
- Fixed a stale anchor (#what-telemetry-data-are-you-collecting-and-why ->
#what-telemetry-data-does-warp-collect-and-why)
- Typo fixes ("y you" -> "you", "Serve" -> "server", "t-short" -> "t-shirt",
"commens"/"sumary" in example prompts)
- changelog: light touch only (Github -> GitHub casing typos)
Left intentionally: linter false positives (proper nouns, JSON field names
like status_message/detail, macOS app-bundle paths Contents/MacOS),
embedded sample WARP.md content, generated license body text, verbatim
error-message headers, and judgment-based screenshot-width warnings.
Co-Authored-By: Oz <oz-agent@warp.dev>
Meaning-preserving polish across agent-platform/, getting-started/, and the root index.mdx/quickstart.mdx: - Terminology: normalize "Third-Party CLI Agents" -> "Third-party CLI agents" and "Cloud Agents Overview" -> "Cloud Agents overview"; "Streamable HTTPS" -> "Streamable HTTP"; lowercase "git repository" -> "Git repository"; "docker" -> "Docker"; "StackOverflow" -> "Stack Overflow"; "Large Language Model(s)" -> lowercase for consistency. - Headings/titles: sentence-case generic titles (Keyboard shortcuts, Supported shells, Agent notifications, Integrations overview, Cloud providers); remove redundant bold inside headings. - Formatting: bold settings paths and UI buttons/menu items instead of backticks/plain text; fix Shift-Tab -> Shift+Tab separator; remove GitBook artifacts (trailing/leading  , escaped backticks); add a missing blank line before a heading. - Grammar/punctuation: "a MCP" -> "an MCP server"; "To add a multiple" -> "To add multiple"; missing periods; "bash, and zsh" -> "bash and zsh". - Cross-references: fix an "environment" link that pointed to integration-setup instead of environments; add trailing slashes to two internal links; descriptive link text for fishshell.com. Co-Authored-By: Oz <oz-agent@warp.dev>
Corrective, meaning-preserving polish: typos, grammar, terminology (per glossary), header sentence-case, Settings-path and UI-element formatting, callout types, and link-text quality. Co-Authored-By: Oz <oz-agent@warp.dev>
Consolidates corrective polish of the Warp docs: typos, grammar, terminology consistency, and style-guide formatting fixes across agent-platform, terminal, code, knowledge-and-collaboration, enterprise, guides, reference, support-and-community, getting-started, changelog, and root pages. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
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 |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Overview
This PR applies broad text-only polish across the docs, including terminology, Markdown formatting, and typo fixes. I reviewed the attached diff, PR description, and spec context; there is no approved spec context to compare against, and I found no blocking correctness or security concerns.
Concerns
- No blocking concerns.
- Non-blocking: a few touched lines still use legacy shortcut notation or quoted UI labels instead of the docs style guide format.
Verdict
Found: 0 critical, 0 important, 3 suggestions
Approve with nits
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
| * **Or start the command yourself, then tag the agent in** | ||
| * Example: | ||
| * If you’ve already launched an interactive tool (for example `psql` or `npm run dev`), you can bring the agent into the running session using the "Use Agent" button in the terminal footer or via `CMD + I` . | ||
| * If you’ve already launched an interactive tool (for example `psql` or `npm run dev`), you can bring the agent into the running session using the "Use Agent" button in the terminal footer or via `CMD + I`. |
Contributor
There was a problem hiding this comment.
💡 [SUGGESTION] This touched line still uses a quoted button label and legacy shortcut formatting; use bold UI text and Cmd+I per the docs style guide.
Suggested change
| * If you’ve already launched an interactive tool (for example `psql` or `npm run dev`), you can bring the agent into the running session using the "Use Agent" button in the terminal footer or via `CMD + I`. | |
| * If you’ve already launched an interactive tool (for example `psql` or `npm run dev`), you can bring the agent into the running session using the **Use Agent** button in the terminal footer or via `Cmd+I`. |
|
|
||
| :::tip | ||
| You can also open the Code Review panel with `CMD – SHIFT – +` on macOS or `CTRL – SHIFT – +` on Windows and Linux. | ||
| You can also open the Code Review panel with `CMD-SHIFT-+` on macOS or `CTRL-SHIFT-+` on Windows and Linux. |
Contributor
There was a problem hiding this comment.
💡 [SUGGESTION] Use + separators and title-case modifier names for shortcuts, including the plus-key shortcut.
Suggested change
| You can also open the Code Review panel with `CMD-SHIFT-+` on macOS or `CTRL-SHIFT-+` on Windows and Linux. | |
| You can also open the Code Review panel with `Cmd+Shift++` on macOS or `Ctrl+Shift++` on Windows and Linux. |
| The main terminal window is not that different from other terminals - there's a place to type commands (Command Input) and a list of the previously executed commands and their outputs. Warp groups those together - each command and output create a Block. You can navigate blocks with your keyboard to easily check what was the command, learn whether it was successful or not, and what was the output, as well as more easily copy the command, output, or both for further processing. | ||
|
|
||
| A main entry point for discovering new features and actions is our Command Palette, which you can access by executing the cmd-p shortcut. | ||
| A main entry point for discovering new features and actions is our Command Palette, which you can access by executing the `CMD-P` shortcut. |
Contributor
There was a problem hiding this comment.
💡 [SUGGESTION] Match the keyboard shortcut format used in the docs style guide.
Suggested change
| A main entry point for discovering new features and actions is our Command Palette, which you can access by executing the `CMD-P` shortcut. | |
| A main entry point for discovering new features and actions is our Command Palette, which you can access by pressing `Cmd+P`. |
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
1 participant
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
Deep, corrective polish across the entire Warp docs content set (
src/content/docs/). This is a cleanup-only pass — typos, grammar, terminology consistency, and style-guide formatting — with no page rewrites, restructures, renames, or navigation/redirect changes.The work was split across three parallel agents, each owning a disjoint set of directories, then merged into this branch:
Total: 181 files changed (+645 / -644).
Representative fixes
AGENTS.md+.agents/references/terminology.md):agent mode→Agent Mode;Github→GitHub;MacOS→macOS;Blocklist→denylist;ambient agent→cloud agent;Agent Modality→Terminal and Agent modes; Oz "programmable agent" → "programmable platform";Streamable HTTPS→Streamable HTTP;WezTerm/iTerm2/VoiceOvercasing.**Settings** > **X**; real clickable UI elements bolded; headers to sentence case (preserving feature/proper names); keyboard shortcuts into backticks with+separators; leftover GitBook artifacts and escaped backticks removed; one mis-leveled:::danger→:::caution.git push –set-upstream(en-dash) →--set-upstream;SHIFT-UP/SHIFT-UPkeybinding →SHIFT-UP/SHIFT-DOWN; broken link slugnvdn/thefuck→nvbn/thefuck; malformed markdown link missing];Secret Reduction→Secret Redaction; assorteda MCP→an MCP,Warps→Warp's, etc.Related issues
None — proactive cleanup pass.
Validation
npm run build— ✅ 337 pages built, 0 errors.npm run typecheck(astro check) — ✅ 0 errors (pre-existing TS deprecation hints in.astro/.tsxcomponents only).python3 .agents/skills/check_for_broken_links/check_links.py --internal-only— ✅ 0 broken internal links (2,907 checked).python3 .agents/skills/style_lint/style_lint.py --all— actionable categories reduced (OZ-TERM 4→0, DEPRECATED 5→2, PRODUCT-CASING 17→2, HEADER-CASE 156→79). Remaining items are confirmed false positives or intentional keeps: proper-noun headers, defined-term acronyms (ZDR/SSO/BYOLLM), code identifiers and keyboard keys in backticks (Enter,.dmg,settings.toml,imagePullSecrets,status_message), and 217 judgment-based screenshot-maxWidthwarnings (left per scope).npm run lint(Trunk) not run — Trunk is not installed locally.Screenshots
None — text-only changes.
Follow-ups
Items intentionally left for human review (out of polish scope or need a domain decision):
secret-redaction.mdxkeeps the literal UI label "Hide secrets in blocklist" — the product UI itself uses the deprecated "blocklist" term.cmd.exesupport wording differs betweensupported-shellsandmigrate-from-windows-terminal; conversation-forking key differs between two pages; skill-directory precedence order differs betweenskills.mdxandskills-as-agents.mdx;subshells.mdxusesdefaults update(likely should bedefaults write).⌘+IvsCMD + Ivs⌘I), "Computer Use"/"Full Terminal Use" body casing vs lowercase page titles, and relative vs absolutedocs.warp.devcross-space link style.how-to-set-up-ollama.mdxand a GitHub MCP guide; a possibly-stray bullet intabs-behavior.mdx.Co-Authored-By: Oz oz-agent@warp.dev