Skip to content

feat(docs): ship public docs site at stainless-code.com/persist#20

Merged
SutuSebastian merged 6 commits into
mainfrom
docs/public-site
Jul 19, 2026
Merged

feat(docs): ship public docs site at stainless-code.com/persist#20
SutuSebastian merged 6 commits into
mainfrom
docs/public-site

Conversation

@SutuSebastian

Copy link
Copy Markdown
Contributor

Summary

  • Add Blume docs app (apps/docs) at /persist — Guides / Recipes / Concepts / Adapters / Reference, TypeDoc→MDX API, Persist brand assets, homepage sections.
  • CI docs job + FTP deploy workflow (merge with docs label, release, or workflow_dispatch); README slimmed to npm landing that links to the site.
  • Agents: docs-voice / product-tenets / update-docs / minimum-diff; retire docs-site plan (lifted into architecture + remaining-roi).

Test plan

  • CI docs job green (docs:api → validate → check → build → audit)
  • After merge: confirm FTP deploy to https://stainless-code.com/persist (sitemap / llms.txt under /persist, no _home routes)
  • Smoke homepage + Cmd+K curated links + a guide/recipe/API page
  • Confirm root README still installs + links to the live site

Blume site in apps/docs (Guides/Recipes/Concepts/Adapters/Reference), TypeDoc→MDX, FTP deploy on docs-labeled merges, and README slimmed to an npm landing digest.
@SutuSebastian SutuSebastian added the docs Public docs site (apps/docs) — merge deploys /persist via FTP label Jul 19, 2026
@changeset-bot

changeset-bot Bot commented Jul 19, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: e2cc2a4

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@SutuSebastian, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 53 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 16aab446-bab9-4211-a666-8d9bef4201f7

📥 Commits

Reviewing files that changed from the base of the PR and between 28c659e and e2cc2a4.

⛔ Files ignored due to path filters (9)
  • apps/docs/public/apple-touch-icon.png is excluded by !**/*.png
  • apps/docs/public/favicon-96x96.png is excluded by !**/*.png
  • apps/docs/public/favicon.ico is excluded by !**/*.ico
  • apps/docs/public/favicon.svg is excluded by !**/*.svg
  • apps/docs/public/icon.svg is excluded by !**/*.svg
  • apps/docs/public/logo.svg is excluded by !**/*.svg
  • apps/docs/public/web-app-manifest-192x192.png is excluded by !**/*.png
  • apps/docs/public/web-app-manifest-512x512.png is excluded by !**/*.png
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (86)
  • .agents/README.md
  • .agents/lessons.md
  • .agents/rules/agents-tier-system.md
  • .agents/rules/docs-governance-priming.md
  • .agents/rules/docs-voice-priming.md
  • .agents/skills/agents-tier-system/SKILL.md
  • .agents/skills/ask-agents/SKILL.md
  • .agents/skills/docs-governance/LIFECYCLE.md
  • .agents/skills/docs-governance/SKILL.md
  • .agents/skills/docs-voice/SKILL.md
  • .agents/skills/minimum-diff/SKILL.md
  • .agents/skills/product-tenets/SKILL.md
  • .agents/skills/update-docs/SKILL.md
  • .agents/skills/writing-agents-config/SKILL.md
  • .changeset/public-docs-site.md
  • .cursor/rules/docs-voice-priming.mdc
  • .cursor/skills/docs-voice
  • .cursor/skills/minimum-diff
  • .cursor/skills/product-tenets
  • .cursor/skills/update-docs
  • .github/CONTRIBUTING.md
  • .github/workflows/ci.yml
  • .github/workflows/deploy-docs.yml
  • AGENTS.md
  • README.md
  • apps/docs/.gitignore
  • apps/docs/.oxfmtrc.json
  • apps/docs/blume.config.ts
  • apps/docs/components.ts
  • apps/docs/components/blume/Footer.astro
  • apps/docs/components/blume/Pagination.astro
  • apps/docs/components/curated-popular.ts
  • apps/docs/content/adapters/framework-adapter.mdx
  • apps/docs/content/adapters/index.mdx
  • apps/docs/content/adapters/meta.ts
  • apps/docs/content/concepts/choosing-codec.mdx
  • apps/docs/content/concepts/choosing-storage.mdx
  • apps/docs/content/concepts/comparison.mdx
  • apps/docs/content/concepts/entry-points.mdx
  • apps/docs/content/concepts/index.mdx
  • apps/docs/content/concepts/lifecycle.mdx
  • apps/docs/content/concepts/meta.ts
  • apps/docs/content/concepts/three-seams.mdx
  • apps/docs/content/guides/faq.mdx
  • apps/docs/content/guides/getting-started.mdx
  • apps/docs/content/guides/hydration.mdx
  • apps/docs/content/guides/idb-react.mdx
  • apps/docs/content/guides/index.mdx
  • apps/docs/content/guides/meta.ts
  • apps/docs/content/guides/migrating.mdx
  • apps/docs/content/recipes/composition.mdx
  • apps/docs/content/recipes/crosstab.mdx
  • apps/docs/content/recipes/index.mdx
  • apps/docs/content/recipes/meta.ts
  • apps/docs/content/recipes/node-fs.mdx
  • apps/docs/content/recipes/options.mdx
  • apps/docs/content/recipes/react-native.mdx
  • apps/docs/content/recipes/wrapping-stores.mdx
  • apps/docs/content/recipes/zod.mdx
  • apps/docs/content/reference/api/index.mdx
  • apps/docs/content/reference/api/meta.ts
  • apps/docs/content/reference/index.mdx
  • apps/docs/content/reference/meta.ts
  • apps/docs/package.json
  • apps/docs/pages/404.astro
  • apps/docs/pages/_home/Batteries.astro
  • apps/docs/pages/_home/FinalCta.astro
  • apps/docs/pages/_home/Hero.astro
  • apps/docs/pages/_home/InstallBox.astro
  • apps/docs/pages/_home/Seams.astro
  • apps/docs/pages/_home/UseCases.astro
  • apps/docs/pages/_home/source-snippets.ts
  • apps/docs/pages/index.astro
  • apps/docs/public/.htaccess
  • apps/docs/public/site.webmanifest
  • apps/docs/scripts/rewrite-api-links.ts
  • apps/docs/theme.css
  • apps/docs/tsconfig.json
  • docs/README.md
  • docs/architecture.md
  • docs/plans/remaining-roi.md
  • docs/roadmap.md
  • knip.json
  • lint-staged.config.js
  • package.json
  • typedoc.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/public-site

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Match Layers comparison tables — emoji marks read better than bare ✓/✗/~.
lint-staged now matches `.mdx`. Nested apps/docs oxfmtrc ignores content/**
so oxfmt cannot collapse ::: callout fences (Blume FAQ / Layers pattern).
Blume (and codemap→express) pull a vulnerable path-to-regexp; pin 6.3.0
like Layers so CI Audit blocks on high/critical stay green.
Drop caret ranges on optional-peer test deps so installs stay exact until an intentional bump.
@SutuSebastian
SutuSebastian merged commit cb6ca1d into main Jul 19, 2026
15 checks passed
@SutuSebastian
SutuSebastian deleted the docs/public-site branch July 19, 2026 13:47
This was referenced Jul 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Public docs site (apps/docs) — merge deploys /persist via FTP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant