docs(audit): fix missing_docs path resolution and document Vertical Tabs Summary mode#75
Merged
Merged
Conversation
Repair the missing_docs audit script so it no longer produces false positives, refresh the feature surface map to match the live docs structure, and document the Vertical Tabs "Summary" tab item mode that shipped behind the VerticalTabsSummaryMode GA flag. Changes: - audit_docs.py: resolve mapped paths against the actual repo root (the prior code joined paths against docs_root.parent and double-counted src/content/docs/...). Accept .mdx as an alternate to .md and index.mdx as an alternate to README.md, matching the Astro Starlight layout. Fall back to a content search before flagging a mapped path as missing so renamed docs don't get flagged. - feature_surface_map.md: update mappings that pointed at the legacy agent-platform/warp-agents/ tree to the real agent-platform/capabilities/ and agent-platform/local-agents/ locations. Add VerticalTabsSummaryMode -> vertical-tabs.mdx. Move OpenWarpLaunchModal to the ignore list (one-time open-source launch modal; covered in the 2026 changelog). - vertical-tabs.mdx: document the new "Tab item" setting with "Focused session" and "Summary" options, including the table row and the key-features bullet. After the fix, the audit reports zero medium-or-higher severity gaps. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> 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 updates the missing-docs audit surface map to match the current Astro Starlight layout, fixes mapped-path resolution for .mdx and index.mdx pages in feature and CLI audits, and documents the Vertical Tabs Summary tab item mode. I reviewed the changed audit logic, mapped documentation paths, and documentation wording against the annotated diff.
Concerns
- No blocking concerns found.
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
approved these changes
May 18, 2026
hongyi-chen
added a commit
that referenced
this pull request
May 26, 2026
…e audit mode Rebases the original PR onto current `main` after PR #75 shipped overlapping path-resolution fixes. The structural cleanup from PR #75 is preserved; this commit reapplies only the additions that PR #75 didn't include. - full-screen-apps.mdx: add a "Kitty keyboard protocol" section so the newly-shipped flag is documented where TUI users will look. - feature_surface_map.md: point KittyKeyboardProtocol at the .mdx file and fix the stale `.warp/skills/...` script-path comment. - audit_docs.py: add an opt-in `--weak-coverage` flag that, on top of the default "mapped == verified" check, also confirms feature keywords actually appear in the mapped doc (low-severity, noisy by design). - SKILL.md: document `--weak-coverage`, the `.md`/`.mdx` resolution behavior, and the correct `crates/warp_features/src/lib.rs` source path. Original author: hongyi-chen <hongyigma@gmail.com> Co-Authored-By: Oz <oz-agent@warp.dev>
4 tasks
hongyi-chen
added a commit
that referenced
this pull request
May 26, 2026
…e audit mode (#52) Rebases the original PR onto current `main` after PR #75 shipped overlapping path-resolution fixes. The structural cleanup from PR #75 is preserved; this commit reapplies only the additions that PR #75 didn't include. - full-screen-apps.mdx: add a "Kitty keyboard protocol" section so the newly-shipped flag is documented where TUI users will look. - feature_surface_map.md: point KittyKeyboardProtocol at the .mdx file and fix the stale `.warp/skills/...` script-path comment. - audit_docs.py: add an opt-in `--weak-coverage` flag that, on top of the default "mapped == verified" check, also confirms feature keywords actually appear in the mapped doc (low-severity, noisy by design). - SKILL.md: document `--weak-coverage`, the `.md`/`.mdx` resolution behavior, and the correct `crates/warp_features/src/lib.rs` source path. Original author: hongyi-chen <hongyigma@gmail.com> Co-authored-by: Oz <oz-agent@warp.dev>
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
2 participants
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
missing_docsaudit script so it no longer produces false positives. The prior code joined surface-map paths againstdocs_root.parent(thesrc/content/directory), which doubledsrc/content/docs/...and made every mapped path appear missing. It also only checked for.mdeven though the live docs are.mdx. The script now resolves paths against the actual repo root, treats.mdxandindex.mdxas legitimate alternates of.mdandREADME.md, and falls back to a docs-wide content search before flagging a mapped path as missing.feature_surface_map.mdso it matches the live Astro Starlight layout: feature flags that previously pointed at the legacyagent-platform/warp-agents/tree now resolve toagent-platform/capabilities/andagent-platform/local-agents/.VerticalTabsSummaryModeGA flag) onterminal/windows/vertical-tabs.mdx, with a new "Tab item" row in the settings table and an entry in the key-features bullet list. Sources confirm the UI shows two segmented controls: View as (Panes/Tabs) and, when View as isTabs, Tab item (Focused session/Summary).OpenWarpLaunchModalflag as ignored. It gates a one-time open-source launch announcement already covered in the 2026 changelog (* Warp is now open source.) and has no recurring surface to document.After these changes,
python3 .agents/skills/missing_docs/scripts/audit_docs.py --severity mediumreports zero gaps.npm run buildsucceeds (318 pages built).Out of scope (follow-ups)
Test plan
python3 .agents/skills/missing_docs/scripts/audit_docs.py --warp-internal /workspace/warp-internal --warp-server /workspace/warp-server --severity mediumreports 0 gapsnpm run buildsucceeds (318 pages built)This PR was created by Oz (running Claude Code).