Skip to content

docs: update Guards page to be skills-first with use cases #819

Merged
qw-in merged 7 commits intomainfrom
quinn/eng-730-update-guards
Apr 29, 2026
Merged

docs: update Guards page to be skills-first with use cases #819
qw-in merged 7 commits intomainfrom
quinn/eng-730-update-guards

Conversation

@qw-in
Copy link
Copy Markdown
Member

@qw-in qw-in commented Apr 29, 2026

Update the guards page to follow skills => cli

@qw-in qw-in self-assigned this Apr 29, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 29, 2026

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

Project Deployment Actions Updated (UTC)
arcjet-docs Ready Ready Preview, Comment Apr 29, 2026 5:30pm

Request Review

Comment thread src/content/docs/guards/index.mdx Outdated
Comment thread src/content/docs/guards/index.mdx Outdated
Copy link
Copy Markdown
Contributor

@arcjet-review arcjet-review Bot left a comment

Choose a reason for hiding this comment

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

Arcjet Review — 🟢 Low Risk

Decision: Approved

Rationale: Documentation-only change to the Guards index page. Restructures content to be skills-first with concrete use case framing, adds Astro Aside/Link imports, version constraints for the SDKs, and JS/Python code examples. No code paths, configuration, or security-sensitive areas affected. Security review checklist applied: no secrets, no auth changes, no injection surfaces, no crypto. The example uses process.env.ARCJET_KEY and os.environ[...], which is the correct pattern.

Summary of Changes

Rewrites src/content/docs/guards/index.mdx to lead with three concrete use cases (prompt injection, runaway spend, PII leakage), adds JS and Python usage examples, fixes the install command (npx skillnpx skills), pins minimum SDK versions, and tweaks the source list. Pure docs change.

Notes

Diff is well under the size threshold. No escalation triggers fired.

Review: 704f9094 | Powered by Arcjet Review

Comment thread src/content/docs/guards/index.mdx
Comment thread src/content/docs/guards/index.mdx
Comment thread src/content/docs/guards/index.mdx
Copy link
Copy Markdown
Contributor

@arcjet-review arcjet-review Bot left a comment

Choose a reason for hiding this comment

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

Arcjet Review — 🟢 Low Risk

Decision: Approved

Rationale: Pure documentation change to the Guards landing page. Restructures the page to be use-case-first with concrete scenarios, adds JS and Python code examples, updates the install command, and bumps the supported version footnotes. No code paths, configuration, or dependencies are affected. Example snippets correctly use environment variables for the API key — no hardcoded secrets. No escalation triggers fire.

Summary of Changes

Rewrites src/content/docs/guards/index.mdx: replaces the problem/solution table with three use-case sections, adds an Aside pointing HTTP users to the quick start, adds JavaScript and Python usage examples, updates supported package versions, and changes the skill install command from npx skill add to npx skills add.

Notes

Docs-only PR, well under the size threshold. Security-review skill applied; no findings.

Review: 85523c73 | Powered by Arcjet Review

Comment thread src/content/docs/guards/index.mdx
Comment thread src/content/docs/guards/index.mdx
Comment thread src/content/docs/guards/index.mdx
qw-in added 6 commits April 29, 2026 16:46
- Move Get started (skill) section to the top
- Add concrete use cases: MCP server tools, agentic pipelines,
  queue consumers, PII scanning, prompt injection in tool results
- Add cross-link to request-based protection
- Re-enable table of contents
- Rename 'The problem' to 'What guards protect against'

Closes ENG-730
@qw-in qw-in enabled auto-merge April 29, 2026 17:26
@qw-in qw-in added this pull request to the merge queue Apr 29, 2026
Merged via the queue into main with commit 9aa1899 Apr 29, 2026
11 checks passed
@qw-in qw-in deleted the quinn/eng-730-update-guards branch April 29, 2026 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants