Skip to content

Commit 62fd5fa

Browse files
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>
1 parent 1584d70 commit 62fd5fa

16 files changed

Lines changed: 38 additions & 25 deletions

.agents/skills/style_lint/style_lint.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@
2424
# Configuration
2525
# ---------------------------------------------------------------------------
2626

27-
DOCS_ROOT = Path("docs")
27+
# Astro Starlight content lives under src/content/docs/, not a top-level docs/.
28+
# This used to be `Path("docs")`, which silently scanned 0 files in the
29+
# Astro layout — running --all reported "No issues found" without auditing
30+
# anything.
31+
DOCS_ROOT = Path("src/content/docs")
2832
CHANGELOG_DIR = DOCS_ROOT / "changelog"
2933
EXCLUDED_DIRS = {"_book", "node_modules", ".docs"}
3034

@@ -134,7 +138,7 @@ class Report:
134138
def find_all_md_files() -> List[Path]:
135139
"""Find all markdown files in docs/, excluding build artifacts and changelog."""
136140
files = []
137-
for f in DOCS_ROOT.rglob("*.md"):
141+
for f in [*DOCS_ROOT.rglob("*.md"), *DOCS_ROOT.rglob("*.mdx")]:
138142
if any(part in EXCLUDED_DIRS for part in f.parts):
139143
continue
140144
# Exclude changelog (historical record)
@@ -148,12 +152,12 @@ def find_changed_md_files() -> List[Path]:
148152
"""Find markdown files changed in the current branch vs main."""
149153
try:
150154
result = subprocess.run(
151-
["git", "diff", "--name-only", "origin/main...HEAD", "--", "docs/"],
155+
["git", "diff", "--name-only", "origin/main...HEAD", "--", str(DOCS_ROOT)],
152156
capture_output=True, text=True, check=True,
153157
)
154158
files = []
155159
for line in result.stdout.strip().split("\n"):
156-
if line.endswith(".md") and os.path.exists(line):
160+
if (line.endswith(".md") or line.endswith(".mdx")) and os.path.exists(line):
157161
p = Path(line)
158162
if not any(part in EXCLUDED_DIRS for part in p.parts):
159163
files.append(p)
@@ -658,7 +662,7 @@ def create_pr_with_fixes() -> None:
658662
"""Create a branch and PR with the auto-fixes."""
659663
branch = "fix/style-lint-auto-fixes"
660664
subprocess.run(["git", "checkout", "-b", branch], check=True)
661-
subprocess.run(["git", "add", "docs/"], check=True)
665+
subprocess.run(["git", "add", str(DOCS_ROOT)], check=True)
662666
result = subprocess.run(["git", "diff", "--cached", "--quiet"])
663667
if result.returncode == 0:
664668
print("No changes to commit.")

astro.config.mjs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,15 @@ export default defineConfig({
6767
defaultProps: {
6868
wrap: true,
6969
},
70+
// Map languages Shiki doesn't bundle to a safe fallback. PromQL
71+
// blocks live in agent-platform/cloud-agents/self-hosting/monitoring.mdx;
72+
// without this alias every build emits noisy "language could not be
73+
// found" warnings while still falling back to plaintext.
74+
shiki: {
75+
langAlias: {
76+
promql: 'text',
77+
},
78+
},
7079
},
7180
head: [
7281
// SEO + PWA parity with the legacy GitBook docs. These were emitted

src/content/docs/guides/agent-workflows/how-to-explain-your-codebase-using-warp-rust-codebase.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar:
1010
import VideoEmbed from '@components/VideoEmbed.astro';
1111
import { Steps } from '@astrojs/starlight/components';
1212

13-
Learn how to use Warp’s AI agent to explore and understand large, unfamiliar codebases — using semantic and symbol-level search.
13+
Learn how to use Warp’s agents to explore and understand large, unfamiliar codebases — using semantic and symbol-level search.
1414

1515
<VideoEmbed url="https://www.youtube.com/watch?v=11rz9OYQ8Hg" />
1616

src/content/docs/guides/agent-workflows/how-to-review-ai-generated-code.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Coding agents can produce hundreds of lines of code in seconds, but shipping tha
1616

1717
## Why review matters
1818

19-
AI agents are fast but imperfect. They hallucinate imports, introduce subtle logic errors, make bad architectural decisions, and duplicate code. Reviewing agent output is the step that turns agentic development from vibe coding into a workflow you can trust.
19+
Agents are fast but imperfect. They hallucinate imports, introduce subtle logic errors, make bad architectural decisions, and duplicate code. Reviewing agent output is the step that turns agentic development from vibe coding into a workflow you can trust.
2020

2121
Common issues in AI-generated code:
2222

src/content/docs/guides/build-an-app-in-warp/building-a-chrome-extension-d3js-javascript-html-css.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import VideoEmbed from '@components/VideoEmbed.astro';
1010
import { Steps } from '@astrojs/starlight/components';
1111

1212
:::tip
13-
This educational module teaches you step-by-step how to replicate the process shown in the video — building a **Sankey diagram Chrome extension** using **D3.js**, debugging, coordinating **multiple AI agents**, and deploying to the **Chrome Web Store**.
13+
This educational module teaches you step-by-step how to replicate the process shown in the video — building a **Sankey diagram Chrome extension** using **D3.js**, debugging, coordinating **multiple agents**, and deploying to the **Chrome Web Store**.
1414
:::
1515

1616
<VideoEmbed url="https://youtu.be/xbvE_aoZ508?si=a3-4iKaSr8nn-esx" />
@@ -41,7 +41,7 @@ This educational module teaches you step-by-step how to replicate the process sh
4141

4242
After fixing missing icons, the extension loads but initially shows only “Loading diagram.”\
4343
\
44-
Debug this by taking a screenshot and feeding it to an AI agent for context by asking:
44+
Debug this by taking a screenshot and feeding it to an agent for context by asking:
4545

4646
```
4747
It says loading diagram — why isn’t the chart appearing?

src/content/docs/guides/build-an-app-in-warp/building-a-slackbot.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The setup takes just a few steps — clone, configure, and run — and requires
1414

1515
## Why this is useful
1616

17-
* Run a self-hosted Slack bot that connects your team’s repos and Warp AI agents.
17+
* Run a self-hosted Slack bot that connects your team’s repos and Warp agents.
1818
* Provide your team with a coding assistant that can answer repo questions or help with PRs directly in Slack.
1919

2020
## Quickstart Setup
@@ -113,7 +113,7 @@ The setup takes just a few steps — clone, configure, and run — and requires
113113
* Authenticates to Slack (Socket Mode and Web API).
114114
* Authenticates to GitHub and clones the listed repos.
115115
* Starts listening for `app_mention` events and threaded messages.
116-
* Routes context and commands to Warp’s AI agent backend.
116+
* Routes context and commands to Warp’s agent backend.
117117
118118
You can stop the bot anytime with `Ctrl + C` or run it persistently with:
119119

src/content/docs/guides/configuration/how-to-set-coding-preferences-with-rules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Learn how to use Warp’s Rules feature to define your personal environment and
1313

1414
<VideoEmbed url="https://youtu.be/zWvRB2zWr-4?si=tv-TIhsqEtLG9iDs" />
1515

16-
This tutorial teaches you how to customize your development setup using **Warp’s Rules** — ensuring the AI agent always works in your preferred environment. Instead of constantly reminding it which package manager or environment to use, you can **store those preferences as persistent Rules** that apply automatically across projects.
16+
This tutorial teaches you how to customize your development setup using **Warp’s Rules** — ensuring agents always work in your preferred environment. Instead of constantly reminding them which package manager or environment to use, you can **store those preferences as persistent Rules** that apply automatically across projects.
1717

1818
<Steps>
1919

src/content/docs/guides/devops/how-to-prevent-secrets-from-leaking.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Learn how to safeguard credentials and sensitive data using Warp’s secret-redu
1313

1414
<VideoEmbed url="https://youtu.be/2ECPFKtQpVk?si=HHw14Tqj-QyHeByX" />
1515

16-
This tutorial shows how to use Warp’s **Rules** to prevent AI agents or collaborators from exposing sensitive information while coding or sharing output. Whether you’re pair-programming, streaming, or reviewing code, Warp can automatically redact secrets before they’re ever seen by an agent.
16+
This tutorial shows how to use Warp’s **Rules** to prevent agents or collaborators from exposing sensitive information while coding or sharing output. Whether you’re pair-programming, streaming, or reviewing code, Warp can automatically redact secrets before they’re ever seen by an agent.
1717

1818
<Steps>
1919

src/content/docs/guides/devops/how-to-write-sql-commands-inside-a-postgres-repl.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ You’ll learn how to:
8484

8585
4. #### Observe How Warp Learns from Context
8686

87-
As you continue issuing prompts, Warp’s AI agent **learns the structure of your database** by observing what’s printed in the REPL output.
87+
As you continue issuing prompts, Warp’s agent **learns the structure of your database** by observing what’s printed in the REPL output.
8888

8989
This means you can ask progressively more complex questions, and Warp will tailor the SQL accordingly.
9090

src/content/docs/guides/external-tools/linear-mcp-retrieve-issue-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: >-
66
---
77
import VideoEmbed from '@components/VideoEmbed.astro';
88

9-
Learn how to connect the Linear MCP server in Warp so your AI agent can access live data — like issues, tickets, and user assignments — directly from your Linear workspace.
9+
Learn how to connect the Linear MCP server in Warp so your agents can access live data — like issues, tickets, and user assignments — directly from your Linear workspace.
1010

1111
<VideoEmbed url="https://youtu.be/jxeMfuS1pXk" />
1212

0 commit comments

Comments
 (0)