Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .agents/skills/missing_docs/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,17 @@ For each gap to address (prioritize high → medium → low):
map is how gaps get lost.
9. Run `--update-snapshot` and commit the refreshed snapshot with the same PR.

### Resolution patterns

Not every finding needs a new doc page — pick the lightest correct fix and verify it against source before applying:

- **User-facing setting** — document it in `terminal/settings/all-settings.mdx` under its TOML section (type/default/options come from the `toml_path` registration).
- **Internal or state-only setting** (one-time banners, migration flags, telemetry-modeled state) — map `section.key -> internal` in the surface map instead of documenting it.
- **Feature flag with a dedicated doc page** — map the flag to that page.
- **Feature flag whose only user-facing surface is an already-documented setting** — map the flag to that setting's doc page rather than writing a new page (for example, a tab-bar visibility flag maps to the all-settings reference).
- **Preview or pre-launch feature with no docs yet** — add it to the surface-map ignore list with a comment; the snapshot diff re-flags it when it promotes to GA.
- **Stale map entry or doc reference** (map hygiene) — confirm the surface is gone from code, then prune the dead entry.

### Drift-watch mode (recurring scheduled agent)

This is the end-to-end workflow for the scheduled cloud agent that keeps docs in sync
Expand Down
81 changes: 60 additions & 21 deletions .agents/skills/missing_docs/references/feature_surface_map.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ CLIAgentRichInput -> src/content/docs/agent-platform/cli-agents/rich-input.md
HOANotifications -> src/content/docs/agent-platform/capabilities/agent-notifications.mdx
OpenCodeNotifications -> src/content/docs/agent-platform/cli-agents/opencode.md
CodexNotifications -> src/content/docs/agent-platform/cli-agents/codex.md
# Codex Warp plugin marketplace integration; documented alongside Codex notifications.
CodexPlugin -> src/content/docs/agent-platform/cli-agents/codex.md
HOARemoteControl -> src/content/docs/agent-platform/cli-agents/remote-control.md
GlobalSearch -> src/content/docs/code/overview.md
FileBasedMcp -> src/content/docs/agent-platform/capabilities/mcp.mdx
Expand All @@ -125,6 +127,38 @@ ConfigurableToolbar -> src/content/docs/terminal/windows/configurable-toolbar.md
SettingsFile -> src/content/docs/terminal/settings/index.mdx
Changelog -> src/content/docs/changelog/index.mdx
Autoupdate -> src/content/docs/support-and-community/troubleshooting-and-support/updating-warp.mdx
ShellSelector -> src/content/docs/getting-started/supported-shells.mdx
WorkflowAliases -> src/content/docs/terminal/entry/yaml-workflows.mdx
KittyImages -> src/content/docs/terminal/more-features/full-screen-apps.mdx
UndoClosedPanes -> src/content/docs/terminal/windows/tabs.mdx
RevertDiffHunk -> src/content/docs/code/code-review.mdx
SshRemoteServer -> src/content/docs/terminal/warpify/ssh.mdx

# Feature flags whose only user-facing surface is a documented setting in the
# all-settings reference (terminal/settings/all-settings.mdx).
# - FullScreenZenMode: the "zen mode" tab-bar visibility knob appearance.tabs.workspace_decoration_visibility
# - AsyncFind: experimental.async_find_enabled
FullScreenZenMode -> src/content/docs/terminal/settings/all-settings.mdx
AsyncFind -> src/content/docs/terminal/settings/all-settings.mdx

# Session sharing (viewing + ACLs are part of the documented session sharing feature)
ViewingSharedSessions -> src/content/docs/knowledge-and-collaboration/session-sharing/index.mdx
SessionSharingAcls -> src/content/docs/knowledge-and-collaboration/session-sharing/index.mdx
SharedSessionWriteToLongRunningCommands -> src/content/docs/knowledge-and-collaboration/session-sharing/index.mdx

# CLI-gated features documented in the CLI reference
ArtifactCommand -> src/content/docs/reference/cli/artifacts.mdx
OzIdentityFederation -> src/content/docs/reference/cli/federate.mdx

# Third-party harness support
AgentHarness -> src/content/docs/agent-platform/cloud-agents/harnesses/index.mdx

# Image context for cloud agents
AmbientAgentsImageUpload -> src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx
CloudModeImageContext -> src/content/docs/agent-platform/local-agents/agent-context/images-as-context.mdx

# Skills on the Oz platform
OzPlatformSkills -> src/content/docs/agent-platform/capabilities/skills.mdx

# Handoff (local <-> cloud, cloud <-> cloud) and snapshots
OzHandoff -> src/content/docs/agent-platform/cloud-agents/handoff/index.mdx
Expand All @@ -144,6 +178,10 @@ NamedAgents -> src/content/docs/agent-platform/cloud-agents/agents.mdx
# Inference: BYOK and custom endpoints
SoloUserByok -> src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx
CustomInferenceEndpoints -> src/content/docs/agent-platform/inference/custom-inference-endpoint.mdx
# Connect a SuperGrok subscription instead of pasting an xAI API key.
SuperGrok -> src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx
# Custom model routers (Settings > AI > Custom Routers) surface in the model picker.
CustomModelRouters -> src/content/docs/agent-platform/inference/model-choice.mdx

# Billing & Usage settings page (redesigned)
BillingAndUsagePageV2 -> src/content/docs/support-and-community/plans-and-billing/index.mdx
Expand Down Expand Up @@ -229,10 +267,17 @@ POST /harness-support/upload-snapshot -> internal
# for exceptions: settings documented on another page (`section.key -> path`)
# or intentionally undocumented (`section.key -> internal`).

# One-time internal state for the deprecated tmux SSH wrapper migration banner;
# not a user-configurable setting.
warpify.ssh.ssh_tmux_deprecation_notice_pending -> internal

## Unlisted docs pages to ignore

# Pages intentionally absent from src/sidebar.ts (one slug per line, e.g.
# `guides/some-page`). Everything else on disk must be reachable via the sidebar.
# Per the page's frontmatter comment: not in the Guides sidebar yet, pending
# team feedback.
guides/agent-workflows/warp-vs-claude-code

## Flags to ignore (internal-only, not user-facing)

Expand Down Expand Up @@ -280,7 +325,6 @@ DefaultAdeberryTheme
AutoupdateUIRevamp
MinimalistUI
AvatarInTabBar
SessionSharingAcls
ImeMarkedText
NewTabStyling
AmbientAgentsRTC
Expand All @@ -297,9 +341,9 @@ CreateProjectFlow
CodeLaunchModal
ValidateAutosuggestions
ClearAutosuggestionOnEscape
OzPlatformSkills
# Rendering detail for markdown tables in notebooks/AI output; no dedicated doc surface.
# Rendering details for markdown tables/Mermaid in notebooks/AI output; no dedicated doc surface.
MarkdownTables
MarkdownMermaid

# UI implementation details (not user-facing features)
FallbackModelLoadOutputMessaging
Expand All @@ -321,7 +365,6 @@ HOAOnboardingFlow
AgentViewConversationListView
BuildPlanAutoReloadBannerToggle
BuildPlanAutoReloadPostPurchaseModal
FreeUserNoAi
ForceLogin
SimulateGithubUnauthed
ConversationApi
Expand All @@ -338,39 +381,33 @@ GitCredentialRefresh
OrchestrationViewerStreamer
OwnerOrchestrationAncestorStreamer

# Non-GA flags in dogfood/preview only
# Sub-feature toggles and pre-launch flags. Section placement does NOT assert
# rollout status (the audit computes that from code); entries here are ignored
# because the toggle itself isn't a documentable surface, or because the
# feature isn't user-facing yet — the snapshot diff flags promotions.
# Grouped Tabs is a macOS-only Preview feature (organize tabs into named,
# collapsible groups); public docs are pending GA promotion, which the snapshot
# diff will flag.
GroupedTabs
LSPAsATool
SshRemoteServer
EmbeddedCodeReviewComments
InteractiveConversationManagementView
MarkdownImages
MarkdownMermaid
EditableMarkdownMermaid
OzIdentityFederation
AgentHarness
# Directory-based tab colors: the user-facing knob is the setting
# appearance.tabs.directory_tab_colors, documented in the all-settings reference.
DirectoryTabColors
ArtifactCommand
CloudModeImageContext
CloudModeHostSelector
AmbientAgentsImageUpload
CodebaseIndexSpeedbump
CodebaseIndexPersistence
SharedSessionWriteToLongRunningCommands
AgentTips
AgentViewPromptChip
AllowOpeningFileLinksUsingEditorEnv
AllowIgnoringInputSuggestions
CodeModeChip
UndoClosedPanes
RevertDiffHunk
ViewingSharedSessions
ShellSelector
FullScreenZenMode
WorkflowAliases
KittyImages
# Internal agent file-search tool plumbing (read tools are not individually documented).
GrepTool
NativeShellCompletions
WelcomeTab
DragTabsToWindows
SshDragAndDrop
ITermImages
Expand All @@ -384,5 +421,7 @@ PredictAMQueries
UseTantivySearch
CommandCorrectionsHistoryRule
SuggestedAgentModeWorkflows
# Implementation toggle choosing skill-based vs slash-command PR comments;
# the user-facing /pr-comments command is mapped via PRCommentsSlashCommand.
PRCommentsSkill
FigmaDetection
Loading
Loading