Skip to content

docs: align hardening + driver docs with Hono-only adapters (#2392) - #2393

Merged
os-zhuang merged 1 commit into
mainfrom
v12-docs-accuracy
Jun 27, 2026
Merged

os-zhuang merged 1 commit into
mainfrom
v12-docs-accuracy

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

First slice of the docs-accuracy pass (#2392), following the adapter trim (#2391).

Fixes (hand-written docs only)

  • docs/HARDENING.md — the "Fastify recipe" imported the now-deleted @objectstack/fastify; rewritten as a Hono recipe using the real objectStackMiddleware(kernel) + secureHeaders() + RateLimiter. CSRF guidance → hono/csrf; CORS example → createHonoApp({ cors }).
  • docs/design/driver-turso.md — dropped the @objectstack/plugin-msw impact row; "All adapters (Next.js, NestJS, …)" → Hono.
  • packages/plugins/driver-memory/README.md — dropped the two @objectstack/plugin-msw bullets.
  • packages/runtime/README.md — framework examples narrowed to Hono (IHttpServer stays described as framework-agnostic).
  • docs/launch-readiness.md — stale "express/fastify" residual note → Hono.

Left as-is (intentional)

  • docs/adr/** and docs/audits/** — dated historical records (e.g. the PolicySchema/http_request liveness audits that motivated the removals). CHANGELOGs likewise.
  • @objectstack/runtime's createDispatcherPlugin and the http_requests_total metric names — those are live, unrelated to the removed flow-node alias.

Verification

Grep confirms no removed-package references remain in current docs. Docs-only; covered by a patch changeset (absorbed into the pending 12.0.0).

Remaining #2392 items (env-rename UPGRADE note, etc.) tracked in that issue.

🤖 Generated with Claude Code

…2.0)

Follow-up to the adapter trim (#2391). Hand-written docs only (ADRs / audits /
CHANGELOGs left as historical):
- docs/HARDENING.md: Fastify recipe → Hono recipe (the @objectstack/fastify
  import was broken after removal); CSRF → hono/csrf; CORS → createHonoApp.
- docs/design/driver-turso.md: drop plugin-msw row; "all adapters" → Hono.
- packages/plugins/driver-memory/README.md: drop plugin-msw bullets.
- packages/runtime/README.md: framework examples narrowed to Hono.
- docs/launch-readiness.md: stale express/fastify residual note → Hono.

Verified: no removed-package refs remain in current docs.

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:08pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation tooling size/s labels Jun 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 2 package(s): @objectstack/driver-memory, @objectstack/runtime.

20 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/concepts/cloud-artifact-api.mdx (via packages/runtime)
  • content/docs/concepts/implementation-status.mdx (via @objectstack/driver-memory, @objectstack/runtime)
  • content/docs/concepts/north-star.mdx (via packages/runtime)
  • content/docs/concepts/packages.mdx (via @objectstack/driver-memory, @objectstack/runtime)
  • content/docs/getting-started/glossary.mdx (via @objectstack/driver-memory)
  • content/docs/guides/api-reference.mdx (via @objectstack/runtime)
  • content/docs/guides/authentication.mdx (via @objectstack/driver-memory, @objectstack/runtime)
  • content/docs/guides/cloud-deployment.mdx (via @objectstack/runtime)
  • content/docs/guides/deployment-vercel.mdx (via @objectstack/driver-memory, @objectstack/runtime)
  • content/docs/guides/driver-configuration.mdx (via @objectstack/driver-memory, @objectstack/runtime)
  • content/docs/guides/hook-bodies.mdx (via @objectstack/runtime)
  • content/docs/guides/kernel-services.mdx (via @objectstack/driver-memory)
  • content/docs/guides/packages.mdx (via @objectstack/driver-memory, @objectstack/runtime)
  • content/docs/guides/plugin-chatbot-integration.mdx (via @objectstack/runtime)
  • content/docs/guides/plugins.mdx (via @objectstack/driver-memory)
  • content/docs/guides/production-readiness.mdx (via @objectstack/runtime)
  • content/docs/guides/single-project-mode.mdx (via @objectstack/runtime)
  • content/docs/protocol/objectos/http-protocol.mdx (via @objectstack/runtime)
  • content/docs/protocol/objectos/index.mdx (via @objectstack/runtime)
  • content/docs/protocol/objectos/lifecycle.mdx (via @objectstack/runtime)

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

This branch was successfully deployed

1 active deployment
Preview — fcd62c4e 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/s tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant