docs: update Guards page to be skills-first with use cases #819
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
93a40ff to
3a75945
Compare
There was a problem hiding this comment.
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 skill → npx 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
There was a problem hiding this comment.
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
- 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
7f694de to
ed24807
Compare
Update the guards page to follow skills => cli