Skip to content

docs: glossary terminology + build hygiene cleanup#46

Merged
hongyi-chen merged 3 commits intomainfrom
hongyi/docs-cleanup
May 8, 2026
Merged

docs: glossary terminology + build hygiene cleanup#46
hongyi-chen merged 3 commits intomainfrom
hongyi/docs-cleanup

Conversation

@hongyi-chen
Copy link
Copy Markdown
Collaborator

Summary

Docs cleanup pass after auditing for issues worth fixing: terminology drift against the AGENTS.md glossary, build noise, and a silently broken style_lint skill. Each commit is scoped to a single fix.

Changes

Apply glossary terminology fixes

  • Replace AI agent(s)agent(s) across 15 guide pages — the glossary calls out the redundant "AI" prefix.
  • Capitalize lowercase agent modeAgent Mode in two guides and the privacy telemetry table (4 occurrences).
  • Replace whitelistallowlist in how-to-customize-warps-appearance.mdx.
  • Intentionally skipped: blocklist references in src/content/. Most refer to Warp UI element names (e.g. Blocklist subshell feature, Hide secrets in blocklist setting) or to the list-of-Blocks UX, not security denylists. A separate content rewrite is the right vehicle for those.

Fix build noise and broken style_lint script

  • astro.config.mjs: Map promqltext through Expressive Code's shiki.langAlias. Shiki doesn't bundle a PromQL grammar, so every build emitted six "language could not be found" warnings for the PromQL examples in monitoring.mdx. Aliasing keeps the semantic promql tag in the source while silencing the warnings.
  • .agents/skills/style_lint/style_lint.py: Update DOCS_ROOT from docssrc/content/docs so the script actually scans Astro Starlight content. Previously --all silently scanned 0 files and reported "No issues found". Also include .mdx alongside .md in the file walk and fix a stale docs/ path in the changed-files / PR helpers. Verified: --all now scans 307 files (was 0).

Validation

  • npm run build succeeds — 316 pages built, no warnings, no RangeError (the prior _llms-txt/support.txt crash was caused by a stale local node_modules where patch-package hadn't applied patches/starlight-llms-txt+0.8.1.patch; reapplying the patch fixed it without touching this branch).
  • python3 .agents/skills/check_for_broken_links/check_links.py --internal-only reports 0 broken links across 314 files / 2,371 internal links.

Artifacts

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

hongyi-chen and others added 2 commits May 8, 2026 15:01
* Replace 'AI agent(s)' with 'agent(s)' across 15 guide pages — the
  glossary calls out the redundant AI prefix.
* Capitalize 'agent mode' to 'Agent Mode' in two guides and the
  privacy telemetry table.
* Replace 'whitelist' with 'allowlist' in the customize-appearance
  guide.

Note: 'blocklist' references in src/content/ were intentionally left
as-is. Most refer to Warp UI element names (e.g. 'Blocklist'
subshell feature, 'Hide secrets in blocklist' setting) or to the
list-of-Blocks UX, not security denylists. A separate content
rewrite pass would be needed to bring those into glossary alignment.

Co-Authored-By: Oz <oz-agent@warp.dev>
* astro.config.mjs: Map 'promql' to 'text' through Expressive Code's
  shiki.langAlias config. Shiki doesn't bundle a PromQL grammar, so
  every build emitted six 'language could not be found' warnings for
  the PromQL examples in monitoring.mdx. Aliasing keeps the semantic
  'promql' tag in the source MDX while silencing the warnings.

* .agents/skills/style_lint/style_lint.py: Update DOCS_ROOT from
  'docs' to 'src/content/docs' so the script actually scans Astro
  Starlight content. Previously '--all' silently scanned 0 files
  and reported 'No issues found'. Also include .mdx alongside .md
  in the file walk and fix a stale 'docs/' path in the changed-files
  and PR helpers.

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 8, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 8, 2026 10:50pm

Request Review

@@ -1,5 +1,5 @@
---
title: "5 AI agent workflows for product managers"
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.

I have a feeling that we included "AI" in the title for SEO reasons, an intentional stray from our style rule that "AI agents" is redundant 🤔

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good catch — restored "AI" in the title for SEO in 4c1b306.

Copy link
Copy Markdown
Contributor

@rachaelrenk rachaelrenk left a comment

Choose a reason for hiding this comment

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

One ? about a page title change, no strong feelings just a hunch we chose that title specifically...otherwise, all LGTM! 🛸

Per Rachael's review comment: keep "AI" in the title intentionally
for SEO even though our style guide treats "AI agents" as redundant.

Co-Authored-By: Oz <oz-agent@warp.dev>
@hongyi-chen hongyi-chen merged commit 62fd5fa into main May 8, 2026
8 of 9 checks passed
dannyneira pushed a commit that referenced this pull request May 8, 2026
* Apply glossary terminology fixes

* Replace 'AI agent(s)' with 'agent(s)' across 15 guide pages — the
  glossary calls out the redundant AI prefix.
* Capitalize 'agent mode' to 'Agent Mode' in two guides and the
  privacy telemetry table.
* Replace 'whitelist' with 'allowlist' in the customize-appearance
  guide.

Note: 'blocklist' references in src/content/ were intentionally left
as-is. Most refer to Warp UI element names (e.g. 'Blocklist'
subshell feature, 'Hide secrets in blocklist' setting) or to the
list-of-Blocks UX, not security denylists. A separate content
rewrite pass would be needed to bring those into glossary alignment.

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

* Fix build noise and broken style_lint script

* astro.config.mjs: Map 'promql' to 'text' through Expressive Code's
  shiki.langAlias config. Shiki doesn't bundle a PromQL grammar, so
  every build emitted six 'language could not be found' warnings for
  the PromQL examples in monitoring.mdx. Aliasing keeps the semantic
  'promql' tag in the source MDX while silencing the warnings.

* .agents/skills/style_lint/style_lint.py: Update DOCS_ROOT from
  'docs' to 'src/content/docs' so the script actually scans Astro
  Starlight content. Previously '--all' silently scanned 0 files
  and reported 'No issues found'. Also include .mdx alongside .md
  in the file walk and fix a stale 'docs/' path in the changed-files
  and PR helpers.

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

* Restore "AI" in PM guide title for SEO

Per Rachael's review comment: keep "AI" in the title intentionally
for SEO even though our style guide treats "AI agents" as redundant.

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>
dannyneira added a commit that referenced this pull request May 8, 2026
* docs: add changelog entry for 2026.05.06 release

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

* fix: address review comments on 2026.05.06 changelog entry

- Add missing blank line before ### header
- Wrap slash commands in backticks (/set-tab-color, /continue-locally, /feedback, /open-file)
- Wrap gh pr view and --version flag in backticks
- Fix keyboard shortcut formatting: cmd+f → `⌘+F`, Ctrl-G → `Ctrl+G`
- Add Linux capitalization
- Fix verb tense: Fixes → Fixed
- Rewrite internal ticket copy to user-facing prose
- Expand Cmd/Ctrl+Shift+Up/Down to platform-split format with symbols

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

* docs: glossary terminology + build hygiene cleanup (#46)

* Apply glossary terminology fixes

* Replace 'AI agent(s)' with 'agent(s)' across 15 guide pages — the
  glossary calls out the redundant AI prefix.
* Capitalize 'agent mode' to 'Agent Mode' in two guides and the
  privacy telemetry table.
* Replace 'whitelist' with 'allowlist' in the customize-appearance
  guide.

Note: 'blocklist' references in src/content/ were intentionally left
as-is. Most refer to Warp UI element names (e.g. 'Blocklist'
subshell feature, 'Hide secrets in blocklist' setting) or to the
list-of-Blocks UX, not security denylists. A separate content
rewrite pass would be needed to bring those into glossary alignment.

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

* Fix build noise and broken style_lint script

* astro.config.mjs: Map 'promql' to 'text' through Expressive Code's
  shiki.langAlias config. Shiki doesn't bundle a PromQL grammar, so
  every build emitted six 'language could not be found' warnings for
  the PromQL examples in monitoring.mdx. Aliasing keeps the semantic
  'promql' tag in the source MDX while silencing the warnings.

* .agents/skills/style_lint/style_lint.py: Update DOCS_ROOT from
  'docs' to 'src/content/docs' so the script actually scans Astro
  Starlight content. Previously '--all' silently scanned 0 files
  and reported 'No issues found'. Also include .mdx alongside .md
  in the file walk and fix a stale 'docs/' path in the changed-files
  and PR helpers.

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

* Restore "AI" in PM guide title for SEO

Per Rachael's review comment: keep "AI" in the title intentionally
for SEO even though our style guide treats "AI agents" as redundant.

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>

* docs: add Oz updates sections to 2026.05.06 and 2026.04.29 changelog entries

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

---------

Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: Hong Yi Chen <hongyi@warp.dev>
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