Skip to content

docs: close missing-docs audit gaps for GA surfaces - #430

Closed
hongyi-chen wants to merge 1 commit into
mainfrom
docs/fill-missing-docs-audit-gaps
Closed

docs: close missing-docs audit gaps for GA surfaces#430
hongyi-chen wants to merge 1 commit into
mainfrom
docs/fill-missing-docs-audit-gaps

Conversation

@hongyi-chen

@hongyi-chen hongyi-chen commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Summary

Ran the missing_docs audit against the current warp-internal and warp-server sources and closed every non-API gap it reported.

Before: 56 gaps — 1 feature, 4 slash commands, 2 settings, 2 map-hygiene, 15 API, 32 staleness
After: 47 gaps — only the 15 API findings and 32 pre-existing staleness findings remain

Features, CLI commands, slash commands, and settings now all report zero findings with full completeness accounting.

Update: reconciled with #407

Since this PR was opened, #407 merged and split the BYOLLM docs into a landing page (bring-your-own-llm.mdx) plus dedicated per-host pages (byollm-aws-bedrock.mdx and byollm-gemini-enterprise.mdx). That dedicated Gemini Enterprise page now fully covers the feature gap this PR originally addressed with prose in the single BYOLLM file.

This branch now merges main and drops the now-redundant Gemini Enterprise prose it had added to bring-your-own-llm.mdx (the only merge conflict; resolved by taking #407's restructured version). The remaining Gemini change here is a one-line audit-map retarget (see Surface map below). This addresses point (1) of @hongyi-chen's review. Point (2) — the API false-positive/regex fix in audit_docs.py — is disjoint and handled by #446, so it stays out of this PR.

Changes

Bring your own LLM: Gemini Enterprise (now owned by #407)

Originally added a Supported hosts section, the workload identity federation credential flow, per-host model availability, setup/troubleshooting, and FAQ coverage to bring-your-own-llm.mdx. #407 has since delivered all of this in the dedicated byollm-gemini-enterprise.mdx page, so those additions are dropped here to avoid duplication and conflicts.

All settings: document auto_approve_bypasses_command_denylist

An always-on, all-surfaces setting missing from the [agents.warp_agent.other] section. It defaults to true, so auto-approve and Run until completion run denylisted commands unless you turn it off — worth being discoverable in the TOML reference. Links to the existing Run until completion and Command denylist sections.

Slash commands: document /copy-debugging-id

The only undocumented slash command with a GUI surface (GuiAndTui). The other three flagged commands are TUI-only and are mapped as internal instead.

Drive-by fix

The Run until completion caution pointed at Settings > Agents > Oz > Input. The section is labeled Warp Agent (confirmed in settings_view/nav.rs), and per the style guide "Oz" is not one of the Agents subpages.

Surface map

  • Retarget the GeminiEnterprise flag to the dedicated byollm-gemini-enterprise.mdx page added by docs: Add Gemini Enterprise (Vertex AI) BYOLLM documentation #407 (previously pointed at the single bring-your-own-llm.mdx).
  • Map the three TUI-only slash commands (/api-keys, /reset-statusline, /vim-mode) to internal, following the convention already used for /status, /clear, /statusline, and /theme.
  • Prune /add-api-key and /clear-provider-api-key, which the map-hygiene audit flagged as gone from code. /api-keys replaced them.
  • Map agents.voice.voice_input_hold_key to internal (SettingSurfaces::TUI). The documented GUI equivalent is agents.voice.voice_input_toggle_key.

Deliberately out of scope

The 15 remaining API findings are public endpoints missing from developers/agent-api-openapi.yaml. Per the surface map's own policy, they require confirming release status and routing through the sync-openapi-spec skill, so they belong in a separate change. Note that #446 fixes an audit_docs.py regex bug that was inflating the API count (parse_openapi_paths() didn't match quoted YAML path keys); after that lands, spec_covered rises 9 → 22. The 32 staleness findings are pre-existing and unchanged by this PR.

Testing

Note for reviewers

I initially drafted this against warpdotdev/gitbook, which turns out to be archived and read-only. That repo also predates several pages that already exist here (custom routers, runners, prompt queueing), so I re-ran the audit against this repo and scoped the work to gaps that are actually still open.

Conversation: https://app.warp.dev/conversation/bd56ad19-fd93-414d-9fbe-bae84d973c24
Run: https://oz.warp.dev/runs/019fb766-fd99-7722-95a0-cc17405215a7

This PR was generated with Oz.

Runs the missing_docs audit against the current client and server sources and
closes every non-API gap it reported. Features, CLI commands, slash commands,
and settings now all report zero findings with full completeness accounting.

Bring your own LLM — add Gemini Enterprise as a second host:
The GeminiEnterprise flag is GA, but the page still said BYOLLM supported AWS
Bedrock "only" with Google support "coming soon". Adds a Supported hosts
section, the workload identity federation credential flow, model availability,
admin/member setup steps, troubleshooting, and FAQ coverage. Unlike Bedrock,
Gemini Enterprise needs no local cloud CLI: Warp exchanges the member's Warp
session for Google credentials via STS, optionally impersonating a configured
service account.

All settings reference — document auto_approve_bypasses_command_denylist:
An always-on, all-surfaces setting that was missing from the
[agents.warp_agent.other] section. It defaults to true, so auto-approve and
Run until completion run denylisted commands unless you turn it off. Links to
the existing Run until completion and Command denylist sections.

Slash commands — document /copy-debugging-id:
The only undocumented slash command with a GUI surface (GuiAndTui).

Drive-by fix:
The Run until completion caution pointed at Settings > Agents > Oz > Input.
The section is labeled "Warp Agent" (confirmed in settings_view/nav.rs), and
per the style guide "Oz" is not one of the Agents subpages.

Surface map:
- Map the three TUI-only slash commands (/api-keys,
  /reset-statusline, /vim-mode) to internal, following the convention already
  used for /status, /clear, /statusline, and /theme.
- Prune /add-api-key and /clear-provider-api-key, which the map-hygiene audit
  flagged as no longer present in code; /api-keys replaced them.
- Map agents.voice.voice_input_hold_key to internal (SettingSurfaces::TUI).
  The documented GUI equivalent is agents.voice.voice_input_toggle_key.
- Map the GeminiEnterprise flag to the BYOLLM page.

The 15 remaining API findings are public endpoints missing from the OpenAPI
spec. Per the surface map's own policy they require confirming release status
and routing through the sync-openapi-spec skill, so they are intentionally left
for a separate change. The 32 staleness findings are pre-existing and unchanged.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Jul 31, 2026
@vercel

vercel Bot commented Jul 31, 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 Jul 31, 2026 1:58pm

Request Review

hongyi-chen pushed a commit that referenced this pull request Jul 31, 2026
Narrow this PR to the audit-script parser fix, the API internal
mappings, and the snapshot regen, so it doesn't conflict with #430's
edits to the same regions of feature_surface_map.md.

Co-Authored-By: Oz <oz-agent@warp.dev>

Copy link
Copy Markdown
Collaborator Author

A missing_docs drift-watch run independently reached most of the same conclusions as this PR. I closed my duplicates (#443, #444) and narrowed my bookkeeping PR (#446) so nothing here conflicts. Two things surfaced that may be worth folding in:

1. The GeminiEnterprise map target may be stale. This PR maps it to bring-your-own-llm.mdx. #407 has since merged a dedicated page, src/content/docs/enterprise/enterprise-features/byollm-gemini-enterprise.mdx, which looks like the better target.

2. Six API findings in the same audit were false positives. parse_openapi_paths() in audit_docs.py only matched unquoted YAML path keys, so every '/path/{param}': looked absent from the spec. #446 fixes the regex; spec_covered goes 9 → 22. Worth knowing if this PR's triage was working from the same inflated API list.

#446 is disjoint from this PR (audit-script fix, /agent/messages/* and /agent/events/* internal mappings, snapshot regen), so the two can merge in either order.

Co-Authored-By: Oz oz-agent@warp.dev

Copy link
Copy Markdown
Collaborator Author

Thanks @hongyi-chen — folded in both:

  1. GeminiEnterprise retarget. Merged main (bringing in docs: Add Gemini Enterprise (Vertex AI) BYOLLM documentation #407) and retargeted the audit map from bring-your-own-llm.mdx to the dedicated byollm-gemini-enterprise.mdx page. The only merge conflict was bring-your-own-llm.mdx; I resolved it by taking docs: Add Gemini Enterprise (Vertex AI) BYOLLM documentation #407's restructured version and dropping this PR's now-redundant Gemini prose, so there's no duplication.

  2. API false positives / parse_openapi_paths() regex. Left to docs: missing_docs audit bookkeeping and OpenAPI path-parsing fix #446 since it's disjoint (audit-script fix + internal /agent/messages/* and /agent/events/* mappings + snapshot regen). I noted in the PR description that docs: missing_docs audit bookkeeping and OpenAPI path-parsing fix #446 raises spec_covered 9 → 22 so the remaining API triage here should be read against the corrected count. Happy to merge in either order.

This reply was generated with Oz.

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.

1 participant