Apply docs style conventions to remaining sections (GROW-6119) - #646
Conversation
…troubleshooting-login - Ctrl+Shift+V paste shortcut normalized to the docs key-chord convention - Fixed a meta-opener sentence, a generic 'more info' link, and a 'click the here link' pattern per AGENTS.md
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@warp-agent-staging[bot] 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 |
![warp-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 the docs style conventions to enterprise/support-and-resources/troubleshooting-login.mdx by removing a meta-opener, improving descriptive link text, replacing a here link reference, and normalizing a keyboard shortcut. I did not find material spec drift, security concerns, broken-link risk, or docs style issues in the changed lines.
Concerns
- None.
Pre-verdict audit
- Comments: No code comments, MDX comments, or inline comments were added or changed.
- Tests: No tests were added or changed; this is a docs-only style cleanup.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /warp-agent-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
1 participant
Summary
Follow-up to GROW-6086 / PR #595: apply the docs repo's key-chord and link/tone style conventions (
AGENTS.md) to the sections PR #595 does not touch.Related issues
GROW-6119 — Apply docs style conventions to the rest of the docs (non-terminal)
Important scope finding
The ticket's premise was that PR #595 covers 56 files scoped to
terminal/plus "the pages that shared the same violations," leaving the rest of the non-terminal sections open for this ticket. In practice, PR #595's Commit 5 ("repo-wide key-chord notation sweep") already normalized key-chord notation on nearly every non-terminal page that had a violation (verified against PR #595's actual file list viagh pr view 595 --json files).Auditable methodology (two separate patterns, run from
src/content/docs, excludingterminal/andchangelog/):CMD-P,CTRL-SHIFT-X):grep -rEl '(CMD|CTRL|ALT|SHIFT|OPT|META)[-+][A-Z0-9]+' src/content/docs --include=*.mdx | grep -v /terminal/ | grep -v /changelog/→ 13 files. Cross-referencing against PR docs: fix terminal docs factual issues + keybinding/link style pass, reconcile with main, settle key-chord casing (GROW-6086) #595's file list: 12 already fixed on docs: fix terminal docs factual issues + keybinding/link style pass, reconcile with main, settle key-chord casing (GROW-6086) #595, 1 not on docs: fix terminal docs factual issues + keybinding/link style pass, reconcile with main, settle key-chord casing (GROW-6086) #595 (
enterprise/support-and-resources/troubleshooting-login.mdx, fixed in this PR). This is the pattern/count the review pass independently re-ran and confirmed.+chords (e.g.CMD + P,CTRL + SHIFT + X), which pattern 1 does not catch:grep -rEl '(CMD|CTRL|ALT|SHIFT|OPT|META) *\+ *[A-Za-z0-9]+' src/content/docs --include=*.mdx | grep -v /terminal/ | grep -v /changelog/→ 10 files (7 not caught by pattern 1). Cross-referencing against docs: fix terminal docs factual issues + keybinding/link style pass, reconcile with main, settle key-chord casing (GROW-6086) #595: 9 already fixed on docs: fix terminal docs factual issues + keybinding/link style pass, reconcile with main, settle key-chord casing (GROW-6086) #595, 1 not on docs: fix terminal docs factual issues + keybinding/link style pass, reconcile with main, settle key-chord casing (GROW-6086) #595 — the same
troubleshooting-login.mdx.Union of both patterns: 20 distinct files, 19 already fixed identically on PR #595's unmerged branch, 1 genuine non-duplicate issue (confirmed both by diffing my fixes against
origin/factory/grow-6086-terminal-docs-factual-styleand bycomm -12/comm -23againstgh pr view 595 --json files). I reverted my duplicate edits to the 19 already-covered files to keep this PR file-disjoint from PR #595, per the ticket's hard constraint. The remaining docs sections listed in the ticket (enterprise/,reference/,platform/,guides/) had zero violations outside what PR #595 already covers, under either pattern.Net result: only one file in the ticket's stated scope had a genuine, non-duplicate issue.
Dependency risk: all of this PR's context depends on PR #595 actually merging. If PR #595 is closed instead of merged, the 19 files this PR intentionally left untouched (12 under pattern 1, 9 under pattern 2, minus the 1 file overlapping both = 19 net) will remain unnormalized on
main, and someone will need to either reopen that work here or restore it from #595's branch.Changes
enterprise/support-and-resources/troubleshooting-login.mdx:CTRL+SHIFT+V→`Ctrl+Shift+V`(key-chord casing/separator convention).I also checked the other listed scope items — bare-URL link text, "here"/"this page" link text — across the full remaining scope (
enterprise/,reference/,platform/,guides/, plus untouched pages insupport-and-community/,getting-started/,knowledge-and-collaboration/,agents/,code/) and found none outside the one instance fixed above.Changelog decision
src/content/docs/changelog/*.mdxholds the bulk of the remaining ALL-CAPS chord hits (116, vs. 0 elsewhere in scope). Per the same decision GROW-6086 already made for this directory: left as a historical record, not normalized.changelog/is a frozen release-notes archive; bothstyle_lint.pyandvalidate_ui_refs.pyalready exclude it by default (confirmed by readingstyle_lint.py'sCHANGELOG_DIRexclusion), and rewriting historical entries to a style that didn't exist when they were written would misrepresent the record. This mirrors the precedent set in PR #595.Validation
npm run typecheck— 0 errors, 0 warnings (7 pre-existing hints only, unrelated to this PR).python3 .agents/skills/validate_ui_refs/validate_ui_refs.py --check-paths --check-commands --warp ../warp— 0 issues.python3 .agents/skills/check_for_broken_links/check_links.py --internal-only— 0 broken links (3928 internal links checked across 379 files).python3 .agents/skills/style_lint/style_lint.py --all— the one pre-existing meta-opener flag on the changed file is now resolved; no new issues introduced.comm -12againstgh pr view 595 --json filesreturns empty for this branch's diff).Follow-ups
Visual verification
The rendered
enterprise/support-and-resources/troubleshooting-login.mdxpage was checked locally (top-of-page H1/intro paragraph, and the "Browser doesn't open when signing in" section with the corrected link wording and the normalizedCtrl+Shift+Vnote callout). Renders cleanly with no layout or styling errors. Screenshots below.Computer-use screenshots (2)
Top of the troubleshooting-login page showing the H1 "Troubleshooting login" title and the intro paragraph below it, rendered with full Warp docs styling (sidebar nav, top nav, right-side TOC).
The "Browser doesn't open when signing in" section showing its numbered list (steps 1-4) and the note callout box below it mentioning the Ctrl+Shift+V paste shortcut.