Skip to content

[12.0] Docs-accuracy pass after the breaking-change batch (adapters/env/Policy/aliases) #2392

Description

@os-zhuang

Docs-accuracy pass after the 11.x→12.0 breaking-change batch. Run once the remaining A-items (#1886, #2377) land. Use the docs-accuracy-audit skill + a targeted sweep for the symbols/concepts removed:

Known doc debt from merged PRs

Scope

framework docs/** (hand-written, not generated) + package READMEs + ../objectui docs/comments. CHANGELOGs and ADRs are historical — leave unless actively misleading.

Activity

  1. os-zhuang commented on Jun 27, 2026

    @os-zhuang
    ContributorAuthor

    Adapter/MSW slice done → #2393 (merged). Rewrote HARDENING to a Hono recipe (+ CSRF/CORS), dropped plugin-msw from driver-turso/driver-memory docs, narrowed runtime README + launch-readiness to Hono. Grep confirms no removed-package refs remain in current docs.

    Re-scan result for the other listed items: already clean. PolicySchema / IUIService / DriverInterface / flow http_request / env-rename / client-react aliases now appear ONLY in docs/adr/** + docs/audits/** (dated historical snapshots — intentionally left) and CHANGELOGs. The #2383 PR already fixed the live env-var READMEs/comments.

    Remaining (optional, not broken-doc fixes):

    • An UPGRADE/migration guide for the 12.0 breaking batch (env renames, removed adapters/APIs) — nice-to-have, no existing doc is wrong.
    • ../objectui e2e/sidebar-text-visibility.spec.ts:27 stale comment (separate repo, trivial).

    The 'fix broken/misleading current docs' goal is essentially complete; closing-eligible once you decide on the optional UPGRADE guide.

  2. os-zhuang commented on Jun 27, 2026

    @os-zhuang
    ContributorAuthor

    Done — #2399 merged. deployment-vercel.mdx MSW Mode fully removed (Hono is the only documented path); implementation-status QA table column → @objectstack/verify. content/docs/** now has zero removed-package refs. 10→11 docs alignment complete across #2393 (internal docs) · #2396 (upgrade guide + README + 11.1.0 re-level) · #2398 (docs site) · #2399 (tail).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions