Skip to content

docs: Starlight documentation site#173

Merged
ascorbic merged 3 commits into
mainfrom
worktree-docs-site
May 24, 2026
Merged

docs: Starlight documentation site#173
ascorbic merged 3 commits into
mainfrom
worktree-docs-site

Conversation

@ascorbic
Copy link
Copy Markdown
Owner

Summary

  • New docs/ Starlight site at the repo root, wired into the pnpm workspace.
  • 33 hand-written pages across Start / Concepts / Guides / Operate / Reference / Project.
  • Embeds the Atmosphere Conference talk on the landing page via stream.place.
  • Cloud emoji as logo, favicon, and hero image.

Page coverage

  • Start here — Welcome, Why run a PDS, Prerequisites, Quick start, First login
  • Concepts — AT Protocol primer, How Cirrus is built, Identity & signing key, Authentication methods, The firehose, Data placement, Costs and limits
  • Guides — Migrate from Bluesky, Migrate to another PDS, Choose a handle, Back up signing key, Sign in to Bluesky, Passkey login, App password, Update, Troubleshoot
  • Operate — Deploy checklist, Monitor, Manage secrets
  • Reference — pds CLI, create-pds CLI, Env vars, wrangler.jsonc, Implemented endpoints, OAuth 2.1 surface, Glossary
  • Project — Status & roadmap, Contributing

Style

Follows the Astro docs style guide: neutral imperative voice, no "we/us/let's", short sentences, headings at h2+, opinionated instructions where a choice has to be made.

Fact-checking

Every CLI command, flag, env var, endpoint table, lifetime, and limit was verified against source code by a fresh review agent and corrected. Notable verifications:

  • Blob limit: 60 MB (matches packages/pds/src/xrpc/repo.ts:672)
  • Session JWT: 120 min access / 90 day refresh (matches packages/pds/src/session.ts:15-17)
  • OAuth access token: 1 hour (matches packages/oauth-provider/src/tokens.ts:11)
  • SIGNING_KEY_PUBLIC documented as a var, not a secret
  • pds identity documented as the PLC-rotation command (PLC-only by nature)
  • Firehose event types match packages/pds/src/sequencer.ts

Run locally

pnpm install
pnpm --filter docs dev

Test plan

  • pnpm --filter docs build passes (34 pages)
  • Landing page renders with cloud logo, hero, and embedded VOD player
  • Sidebar navigation works across all sections
  • Hero cloud centers correctly on mobile widths
  • Manual spot-check of a few pages once deployed

A Starlight site covering install, concepts, guides, operations, and
reference for Cirrus. Embeds the Atmosphere Conference talk on the
landing page as an end-to-end walkthrough.

The docs/ workspace is wired into pnpm-workspace.yaml; run with
`pnpm --filter docs dev`.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 24, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
atproto-pds 1b1e66c May 24 2026, 03:26 PM

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 24, 2026

Open in StackBlitz

npm i https://pkg.pr.new/create-pds@173
npm i https://pkg.pr.new/@getcirrus/oauth-provider@173
npm i https://pkg.pr.new/@getcirrus/pds@173

commit: 1b1e66c

@ascorbic ascorbic enabled auto-merge (squash) May 24, 2026 15:26
@ascorbic ascorbic merged commit 79200c1 into main May 24, 2026
5 checks passed
@ascorbic ascorbic deleted the worktree-docs-site branch May 24, 2026 15:27
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.

1 participant