public-docs
Public Docs
Use this workflow to produce docs that are crisp, task-oriented, and trustworthy for external users.
Load only the references needed for the request:
| Task | Read |
|---|---|
| Understand docs app layout and constraints | references/api-surface.md |
| Draft or revise common docs pages | references/common-use-cases.md |
| Diagnose docs quality/build failures | references/troubleshooting-workarounds.md |
Core invariants
- Keep docs audience-facing: explain user outcomes, not internal implementation chatter.
- Match the local docs contract in
packages/docs/src/content/docs/contribute/documentation-guidelines.md. - For new or substantially edited pages, require frontmatter fields:
type,summary,prerequisites,related. - Include concrete verification steps for tutorial/troubleshooting content.
- End each page with an explicit "next step" path through internal links.
More from getsentry/junior
nitro
Build and deploy universal JavaScript servers with Nitro v3. Use when working with nitro.config.ts, defineNitroConfig, defineHandler, defineConfig, server.ts entry, filesystem routing, route rules, useStorage, defineCachedHandler, useDatabase, definePlugin, runtime hooks, Vercel/Cloudflare deployment, or migrating from Nitro v2/nitropack.
2deslop
Simplifies code interfaces and removes codebase slop while preserving behavior. Use when asked to "deslop", "simplify this interface", "remove cruft", "clean up comments", or "reduce code slop". Enforces hard guardrails for smaller public surfaces, dead-code removal, and high-signal comments.
1vercel-sandbox
Investigate Vercel Sandbox lifecycle, timeout, snapshot, and persistence behavior. Use when users ask about Vercel Sandbox, `@vercel/sandbox`, `Sandbox.create`, `Sandbox.get`, why files disappeared, how snapshots differ from persistence, or whether Vercel's persistent sandbox beta applies.
1vercel-queues
Build and operate Vercel Queues with @vercel/queue across push and poll consumers. Use when users ask about "vercel queues", "@vercel/queue", "queue/v2beta", "handleCallback", "PollingQueueClient", "receive", queue retries, visibility timeouts, idempotency keys, or queue region routing.
1slack-msw-tests
Author Slack HTTP integration tests using the repository MSW harness and fixture factories. Use when asked to add a Slack integration test, mock Slack API calls with MSW, test Slack action HTTP behavior, or assert Slack request payloads in tests.
1slack-development
Implement Slack bot behavior with correct Slack-documented message formats, inbound mention/event routing, and long-running task UX. Use when asked to "format Slack messages", "fix Slack markdown", "debug thread mentions", "improve Slack bot UX", "add streaming in Slack", or "build Slack Chat SDK behavior". Covers mrkdwn quirks, Events API payload patterns, routing guardrails, and Chat SDK implementation patterns.
1