Skip to content

docs(missing_docs): update surface map and snapshot#345

Merged
hongyi-chen merged 1 commit into
mainfrom
oz/docs-audit-bookkeeping
Jul 20, 2026
Merged

docs(missing_docs): update surface map and snapshot#345
hongyi-chen merged 1 commit into
mainfrom
oz/docs-audit-bookkeeping

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Companion audit-bookkeeping PR for this missing_docs drift-watch run. Collects all feature_surface_map.md mappings and the regenerated surface_snapshot.json so feature PRs stay focused and conflict-free.

Changes

  • Runners feature mappings — map CloudRunners and CloudAgentRunners (now GA) to platform/runners.mdx, and re-map the five oz runner* CLI entries from the stale gated:CloudAgentRunnerCLICommands sentinel (that flag was removed when the feature went GA) to platform/runners.mdx. This clears the 5 map-hygiene findings.
  • TUI-only slash commands — map /exit and /view-logs to internal. Both are added only when the settings mode is TUI (warp-tui), so they aren't present in the GUI desktop app or on the public slash-commands page. Consistent with the existing general.autoupdate_enabled -> internal TUI precedent.
  • Snapshot regensurface_snapshot.json refreshed via --update-snapshot. Captures the runner CLI/flags, CloudRunners/CloudAgentRunners GA promotions, code.editor.auto_save, the new factory/agent API routes, and the new tui-migrate-setup bundled skill.

The mapped platform/runners.mdx target lands in the sibling runners PR (#343); map hygiene only requires the target to exist on main, so this PR is independently mergeable.

Deferred findings (nothing silently dropped)

  • 34 public API endpoints missing from the OpenAPI specfactory/* (files, automations, avatar, source, syncs, plan, apply), agent/artifacts/*, agent/events*, agent/messages*, agent/schedules/{id}*, and agent/run-by-external-reference. warp-server is private and these are not in the released developers/agent-api-openapi.yaml. Per the skill's public/private guardrail they must not be hand-documented. Route any publicly released endpoints through the sync-openapi-spec skill as a separate change; defer the rest. Left as standing findings so the pressure remains.
  • 32 potentially-stale/terminology findings (e.g. "warp ai", "ai credits", "agent-mode", "warp terminal", "ambient agent") — owned by the style_lint skill per SKILL.md; deferred there rather than fixed here.

Reviewers

Source owners for the mapped surfaces: @moirahuang (slash commands), @bnavetta/@ianhodge (runner CLI).

Validation

npm run build passes (348 pages). Re-running the audit shows all runner, setting, slash, and map-hygiene findings resolved; only the deferred API + terminology findings remain.

Conversation: https://staging.warp.dev/conversation/1a0de95c-efc7-4af6-941b-bb8c5b9c83c7
Run: https://oz.staging.warp.dev/runs/019f8078-72eb-7187-aba7-cfc11da0d5a4

This PR was generated with Oz.

Map the CloudRunners/CloudAgentRunners flags and oz runner CLI to the new
runners page, re-map the stale gated:CloudAgentRunnerCLICommands entries (flag
removed on GA), mark the TUI-only /exit and /view-logs slash commands internal,
and regenerate surface_snapshot.json.

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

vercel Bot commented Jul 20, 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, Comment Jul 20, 2026 5:14pm

Request Review

@moirahuang moirahuang left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving from the TUI side

@hongyi-chen
hongyi-chen marked this pull request as ready for review July 20, 2026 23:15
@hongyi-chen
hongyi-chen merged commit c5ac278 into main Jul 20, 2026
8 checks passed
@hongyi-chen
hongyi-chen deleted the oz/docs-audit-bookkeeping branch July 20, 2026 23:16
@oz-for-oss

oz-for-oss Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

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 /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@oz-for-oss oz-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This bookkeeping PR updates the missing-docs surface map and regenerated surface snapshot for runner-related surfaces, TUI-only slash commands, and newly detected platform/API surfaces.

Concerns

  • The new runner mappings point at src/content/docs/platform/runners.mdx, but that page is not added by this PR and is absent from the checked-out docs repo/base context, so merging this branch before the runners page lands leaves the surface map with missing target findings.

Verdict

Found: 0 critical, 1 important, 0 suggestions

Request changes

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

# `--runner` flag on `run-cloud`; CloudAgentRunners gates the `oz runner` CRUD
# commands and the runner dropdown in the orchestration card. Both are GA
# (default cargo features).
CloudRunners -> src/content/docs/platform/runners.mdx

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [IMPORTANT] src/content/docs/platform/runners.mdx is the target for these new mappings, but this PR does not add that page and it is absent from the checked-out docs repo; merging this before the runners page lands will leave map hygiene with missing-target findings. Add/merge the runners page first, or keep these entries gated until the target exists.

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.

3 participants