Skip to content

docs(content): align docs site with 11 breaking changes (Hono-only, removed APIs) - #2398

Merged
os-zhuang merged 1 commit into
mainfrom
v11-content-docs
Jun 27, 2026
Merged

os-zhuang merged 1 commit into
mainfrom
v11-content-docs

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

The user-facing docs site (content/docs/**, docs.objectstack.ai) still documented removed packages/APIs. This sweeps it for everything removed in 11.

Fixed

  • packages.mdx + concepts/packages.mdx — Framework Adapters → Hono-only; removed the 6 non-Hono adapter sections + plugin-msw sections + fixed the dependency ASCII tree.
  • deployment-vercel.mdx — removed the broken Next.js "Option A" (@objectstack/nextjs); Hono is the server path; intro reframed + a <Callout> flags the removed MSW mode.
  • environment-variables.mdx — alias table reframed: ecosystem names (DATABASE_URL, AUTH_SECRET, …) are permanent/silent; added a "Removed in 11" note for OS_MULTI_TENANT / OBJECTSTACK_METADATA_WRITABLE / AUTH_BASE_URL.
  • One-liners — flow.mdx/business-logic.mdx (http_request→http), client-sdk.mdx (query aliases removed), metadata-service.mdx (IUIService removed), references/index.mdx (PolicySchema row), plugins.mdx (plugin-msw), schema.mdx/security.mdx/adding-a-metadata-type.mdx (env renames), authentication.mdx (removed the MSWPlugin example).

Left as-is (intentional)

  • docs/adr/** + docs/audits/** (historical), http_requests_total metric names, and @objectstack/service-ai (correctly documented as cloud/Enterprise — open = MCP-only).

Deferred → follow-up

  • deployment-vercel.mdx MSW-mode how-to section + its checklist/comparison entries (flagged by the callout).
  • implementation-status.mdx QA-table plugin-msw column (snapshot doc).

Content-only (no package changes). <Callout type="warn"> matches existing usage.

🤖 Generated with Claude Code

Sweep of content/docs/** (the docs.objectstack.ai site) for symbols/packages
removed in 11. ADRs/audits and metric names (http_requests_total) left as-is;
service-ai references kept (correctly documented as cloud/Enterprise).

- packages.mdx + concepts/packages.mdx: Framework Adapters → Hono-only; removed
  the 6 non-Hono adapter sections, the plugin-msw sections, and fixed the
  dependency ASCII tree.
- deployment-vercel.mdx: removed the broken Next.js "Option A" (@objectstack/nextjs);
  Hono is the server path; intro reframed + a callout flags the removed MSW mode.
- environment-variables.mdx: alias table reframed (ecosystem names permanent/silent;
  OS_MULTI_TENANT / OBJECTSTACK_METADATA_WRITABLE / AUTH_BASE_URL removed-in-11 note).
- one-liners: flow.mdx / business-logic.mdx (http_request→http), client-sdk.mdx
  (query aliases removed), metadata-service.mdx (IUIService removed),
  references/index.mdx (PolicySchema row), plugins.mdx (plugin-msw), schema.mdx /
  security.mdx / adding-a-metadata-type.mdx (env renames), authentication.mdx
  (removed the MSWPlugin browser-kernel example).

Deferred (follow-up): deployment-vercel.mdx MSW-mode how-to section + its
checklist/comparison entries, and implementation-status.mdx QA table column.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 27, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jun 27, 2026 5:55pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/m labels Jun 27, 2026
@os-zhuang
os-zhuang merged commit 11b9e4d into main Jun 27, 2026
15 checks passed
@os-zhuang
os-zhuang deleted the v11-content-docs branch June 27, 2026 17:59
os-zhuang added a commit that referenced this pull request Jun 27, 2026
…Vercel guide (#2399)

Closes the two deferred items from the docs-site pass (#2398 / #2392):
- deployment-vercel.mdx: removed the entire MSW Mode section and all its
  references (intro table, "Choosing the Mode", the MSW checklist subsection,
  the Comparison table) — `@objectstack/plugin-msw` is gone. Hono server mode is
  now the single documented path; a short callout notes the removal.
- implementation-status.mdx: QA table `@objectstack/plugin-msw` column →
  `@objectstack/verify` (the actual test harness).

content/docs/** now has no removed-package references (only an intentional
"removed in 11" callout). MDX validated by Build Docs.

Co-authored-by: Jack Zhuang <277994282+os-zhuang@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview — 98a3c404 Deployed Jun 27, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/m

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant