docs(audit): tier 2/3/5 — feature-name + Github casing sweep#108
Conversation
|
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 |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR applies documentation casing updates across page titles, link text, feature names, and GitHub references. I reviewed the annotated diff, the PR description, and the available spec context; the changes are docs-only and align with the documented casing conventions.
Concerns
No blocking concerns found. No approved or repository spec context was available for additional spec-drift validation.
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
…ontext / Agent Mode / Command Palette casing in privacy.mdx, fix Github → GitHub in guides Casing sweep after the orchestration-launch + multi-agent merges. ## Title sentence case (deployment-patterns, managing-cloud-agents) * deployment-patterns.mdx, managing-cloud-agents.mdx — page titles switched from Title Case to sentence case, matching their sidebar labels. ## Body-text link sentence case ([Self-Hosting], [Deployment Patterns]) Per AGENTS.md (sentence-case headers; proper-feature-name casing in PROPER_FEATURE_NAMES); the page itself is 'Self-hosting' so link text should match: * enterprise/getting-started/getting-started-enterprise.mdx * agent-platform/cloud-agents/platform.mdx * agent-platform/cloud-agents/overview.mdx * agent-platform/cloud-agents/faqs.mdx (3 occurrences, including one [Deployment Patterns] → [Deployment patterns]) * reference/api-and-sdk/troubleshooting/errors/operation-not-supported.mdx ## Feature-name PRODUCT-CASING (Codebase Context / Agent Mode / Command Palette) * code/overview.mdx:9 — 'codebase context' → 'Codebase Context' * privacy.mdx telemetry table (8x) — event-description column updated to capitalize the feature names. Event names in the left column are emitted by product code and unchanged. ## External name casing (Github → GitHub) * guides/.../how-to-run-3-agents-...mdx:52 — prompt example * guides/build-an-app-in-warp/building-a-real-time-chat-app-...mdx:2,232 — page title + appendix link (also dropped a trailing space) * guides/external-tools/github-mcp-summarizing-...mdx:2 — page title ## Skipped (false positives) * enterprise/index.mdx:12 'Warp Terminal' — legitimate distinguishing usage (it's the bullet that distinguishes Warp Terminal from Oz). * sending-us-feedback.mdx:109,112 'MacOS' — literal macOS app-bundle directory name in /Applications/.../Contents/MacOS/<binary>. * slash-commands.mdx:21 'agent mode' — unable to locate a lowercase 'agent mode' string on that line; likely a lint false positive. Validation: 0 broken links / 2577 internal, lint clears 7 PRODUCT-CASING + Title Case + External-Casing warnings, 332 pages build clean. Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen
force-pushed
the
hyc/audit-tier2-casing
branch
from
71990d6 to
1c29442
Compare
2 participants
Post-orchestration-launch audit, pass 2: align titles + link text + feature-name casing across docs.
Changes
Title sentence case
deployment-patterns.mdx:2'Deployment Patterns' → 'Deployment patterns'managing-cloud-agents.mdx:2'Managing Cloud Agents' → 'Managing cloud agents'Both match their existing sidebar labels.
Body-text link sentence case
The Self-hosting page title is sentence case (
Self-hosting), but seven links throughout the corpus used[Self-Hosting](Title Case). One link also used[Deployment Patterns]. Fixed in:enterprise/getting-started/getting-started-enterprise.mdx:166agent-platform/cloud-agents/platform.mdx:188agent-platform/cloud-agents/overview.mdx:60agent-platform/cloud-agents/faqs.mdx(L60, L206, L229)reference/api-and-sdk/troubleshooting/errors/operation-not-supported.mdx:58Feature-name PRODUCT-CASING (Codebase Context / Agent Mode / Command Palette)
code/overview.mdx:9— 'codebase context' → 'Codebase Context'privacy.mdx(8×) — telemetry table descriptions. Event names in the left column are emitted by product code and remain unchanged; descriptions in the right column now match the canonical feature-name casing.External-name casing (Github → GitHub)
guides/agent-workflows/how-to-run-3-agents-in-parallel-...mdx:52— prompt exampleguides/build-an-app-in-warp/building-a-real-time-chat-app-...mdx:2,232— page title + appendix link (also dropped a stray trailing space)guides/external-tools/github-mcp-summarizing-...mdx:2— page titleIntentionally skipped (false positives)
enterprise/index.mdx:12'Warp Terminal' — legitimate distinguishing usage (the bullet that distinguishes Warp Terminal from Oz). Per AGENTS.md:Warp (not 'Warp Terminal' unless specifically distinguishing)— this is the exception case.sending-us-feedback.mdx:109,112'MacOS' — literal macOS app-bundle directory name in/Applications/Warp.app/Contents/MacOS/<binary>. Cannot change without breaking the path.slash-commands.mdx:21'agent mode' — couldn't locate a lowercase "agent mode" on that line; appears to be a lint false positive.Validation
Stacking
This PR sits alongside #107 (Tier 1 terminology drift). Both target
main; they touch overlapping files (overview.mdx,privacy.mdx) but disjoint regions. PR #107 can be merged first or after.Tier 6 (blocklist → denylist sweep) will follow as a separate PR.
Co-Authored-By: Oz oz-agent@warp.dev