Skip to content

docs-audit: surface map + snapshot bookkeeping (2026-08-05 drift-watch) - #482

Merged
hongyi-chen merged 2 commits into
mainfrom
docs-audit/bookkeeping-2026-08-05
Aug 5, 2026
Merged

docs-audit: surface map + snapshot bookkeeping (2026-08-05 drift-watch)#482
hongyi-chen merged 2 commits into
mainfrom
docs-audit/bookkeeping-2026-08-05

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Bookkeeping for the 2026-08-05 missing_docs drift-watch run: surface-map decisions for everything triaged in this run, plus a refreshed surface snapshot so the next run diffs against today's baseline. Both audit modes exited 0 with no skipped audits and no unaccounted surface items.

Changes

.agents/skills/missing_docs/references/feature_surface_map.md

  • GET /.well-known/oauth-authorization-serverinternal

  • GET /.well-known/oauth-protected-resource/api/v1/mcp/factoryinternal

    RFC 8414 / RFC 9728 OAuth discovery documents that MCP clients fetch automatically before authenticating against the hosted Factory MCP endpoint (router/handlers/public_api/oauth2.go). They are registered only when the dogfood-only factory_mcp flag is on (factory_mcp: false in config/prod.yaml), are absent from warp-server's canonical public spec, and are machine-facing protocol metadata rather than a documentable API surface.

  • GET /factory/{uid}/metricsinternal

    Added to the existing Factory block. Factory is not publicly released, and the operation carries x-internal: true in warp-server's canonical spec, so the publish filter strips it from the docs copy.

  • appearance.zero_state.freeze_animation_when_unfocusedsrc/content/docs/cli/configuration.mdx

    Warp Agent CLI-only setting (SettingSurfaces::TUI), documented on the CLI configuration page rather than the all-settings reference, matching the other appearance.zero_state knobs.

.agents/skills/missing_docs/references/surface_snapshot.json

  • Regenerated with --update-snapshot. New entries: the four API routes above plus POST /api/v1/agent/runs/{runId}/scores, the Oz web app route artifacts/:artifactUid, the server tool get_media_artifact_links, and the setting appearance.zero_state.freeze_animation_when_unfocused.

Companion feature PRs from this run

The surface-map entry for freeze_animation_when_unfocused points at a page that already exists on main, so this PR is independently mergeable in any order.

Deferred findings (nothing dropped)

OpenAPI spec drift — route through the sync-openapi-spec skill, not hand-written docs. Three released endpoints are in warp-server's canonical spec without x-internal but missing from developers/agent-api-openapi.yaml:

  • GET /agent/artifacts/{artifactUid}/download
  • GET /agent/run-by-external-reference
  • POST /agent/runs/{runId}/scores

The sync script's --mode diff reports no unclassified (!) items, but a regenerated subset would also add research-preview Agent Memory schemas (AgentMemoryCreateConfig, AgentMemoryResponse, AgentMemoryUpdateConfig, AgentAutoMemoryCreateConfig, AgentAutoMemoryResponse, MemoryStoreAttachmentResponse), plus modifications to 18 existing schemas. Publishing memory configuration while AIMemories is still research preview would contradict the skill's public/private guardrail, so this run stopped short of applying the sync. Recommended follow-up: decide whether those schemas should be excluded by the sync policy or marked x-internal in warp-server, then run sync-openapi-spec as its own PR. POST /agent/runs/{runId}/scores is also worth a second look — it exists for judge runs reporting Factory scorer verdicts, so it may warrant x-internal upstream.

Terminology/staleness (30 remaining findings). Every match was inspected in context and confirmed correct as written: telemetry event tables in privacy.mdx, the current "AI Command Search" feature name, agent-mode URL slugs and image filenames, the "AI credits" bucket name, and deliberate "Warp terminal" vs. Oz distinctions. Two genuine violations were fixed in #481. Broader wording enforcement remains with the style_lint skill.

Weak coverage (81 findings, --weak-coverage). Spot-checked and confirmed to be keyword-heuristic noise: for example GroupedTabsterminal/windows/tabs.mdx (four "tab group" mentions), CloudRunnersplatform/runners.mdx (37 "runner" mentions), NamedAgentsplatform/agents.mdx (covers cloud agents throughout). No action taken.

Clean categories. No findings for feature flags, CLI commands, map hygiene, stale doc references, unlisted sidebar pages, or changelog review.

Validation

  • audit_docs.py (coverage and --diff) exit 0, audits_skipped empty, unaccounted empty.
  • After the changes, the slash-command, setting, and three internal API findings no longer appear; remaining API findings are the three spec-sync items above.
  • npm run build passes; check_links.py reports 0 broken links.

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

Map the Factory MCP OAuth discovery routes and GET /factory/{uid}/metrics as
internal, point the new CLI zero-state setting at the CLI configuration page,
and refresh the surface snapshot.

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

vercel Bot commented Aug 5, 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 Aug 5, 2026 7:25pm

Request Review

@cla-bot cla-bot Bot added the cla-signed label Aug 5, 2026
@hongyi-chen
hongyi-chen marked this pull request as ready for review August 5, 2026 19:23
@hongyi-chen
hongyi-chen enabled auto-merge (squash) August 5, 2026 19:23
@oz-for-oss

oz-for-oss Bot commented Aug 5, 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 PR updates missing_docs bookkeeping by classifying newly triaged surfaces in feature_surface_map.md and refreshing surface_snapshot.json for the 2026-08-05 drift-watch baseline.

Concerns

  • No blocking general, security, or spec-alignment concerns found in the attached diff.

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

@hongyi-chen
hongyi-chen merged commit 3f415fa into main Aug 5, 2026
8 checks passed
@hongyi-chen
hongyi-chen deleted the docs-audit/bookkeeping-2026-08-05 branch August 5, 2026 19:30
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.

2 participants