Repository navigation
docs: close week-of doc gaps (os publish removal, RLS current_user, search, authz, SDUI, dataset joins, package-first) - #2338
Merged
Conversation
…search, authz, SDUI styling, dataset joins, package-first Audit of ~1 week of changes (298 commits, 3 breaking, 20 new ADRs) surfaced hand-written docs that were stale or missing. All shapes verified against the current spec/CLI. P1 — docs were WRONG: - os publish / os rollback removed (#2237): rewrite publish-and-preview around `os package publish`; fix cloud-deployment, cloud-artifact-api, protocol objectos/objectql docs, README, platform skill (migration `os rollback` is gone too — migrate is plan/apply, forward-only). - RLS current_user (ADR-0068): permission.mdx + core-concepts dropped the removed singular `current_user.role` / `current_user.region`; `roles` is a string array. - sharingModel enum (ADR-0055/0056): object.mdx adds public_read / public_read_write / controlled_by_parent + legacy aliases. P2 — shipped but undocumented: - Record search (ADR-0061): data-modeling — `searchableFields` + `$search`. - Unified authz (ADR-0066): security — `sys_capability` registry, object `access` posture, object `requiredPermissions`. - SDUI styling (ADR-0065): page.mdx — `responsiveStyles` (preferred channel). - Dataset multi-hop joins (ADR-0071): analytics-datasets — dotted paths, <=3 hops, to-one only. - Package-first authoring (ADR-0070): metadata-lifecycle — writable-base contract. P3: - Built-in identity roles (ADR-0068) in security; per-env @better-auth/sso + `features.sso` note in auth-sso (ADR-0069). - Status-header correction on ADR-0061 / ADR-0071 (code shipped; headers lagged). Docs-only. Build Docs CI validates MDX. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
os-zhuang
added a commit
that referenced
this pull request
Jun 26, 2026
…eys, dataset include) (#2340) Browser/dogfood verification of the features documented in #2338 (booted app-showcase, exercised at runtime) confirmed $search / searchableFields and multi-hop dataset joins work as documented, but surfaced two doc inaccuracies in #2338 itself: - page.mdx: responsiveStyles breakpoint keys are `large` / `medium` / `small` / `xsmall` (desktop-first — `large` is the unconditional base, the rest are max-width overrides) per ResponsiveStylesSchema, NOT the `xs/sm/md/lg/xl/2xl` axis (those are BreakpointName, used by layout columns/visibility/order). Verified against the served showcase_styling_gallery page metadata (key: `large`). - analytics-datasets.mdx: multi-hop joins must be DECLARED in the dataset's `include` (joins are derived from include; only declared paths are joinable). Verified live: an inline dataset on showcase_invoice_line with include:['invoice.account'] + dotted-path dimension `invoice.account.industry` returns correctly-joined rows. Docs-only. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What & why
A documentation-gap audit of ~1 week of changes (298 commits, 3 breaking, 20 new ADRs) found hand-written docs that were either stale/wrong or missing for shipped features. All shapes were verified against the current spec/CLI before writing.
P1 — docs were actively wrong
os publish/os rollbackremoved (feat(cli)!: remove legacy os publish / os rollback commands #2237). Rewrotepublish-and-preview.mdxaroundos package publish(publish → package version → optional--env --install); fixedcloud-deployment,cloud-artifact-api,protocol/objectos/{index,lifecycle},protocol/objectql/{index,schema},README, and the platform skill. Migrationos rollbackis gone too —os migrate plan|apply, forward-only.current_user(ADR-0068).permission.mdx+core-concepts.mdxdropped the removed singularcurrent_user.role/current_user.region;current_user.rolesis a string array ('x' in current_user.roles).sharingModelenum (ADR-0055/0056).metadata/object.mdxaddspublic_read/public_read_write/controlled_by_parent+ documents the legacy aliases.P2 — shipped but undocumented
data-modeling.mdxsearchableFields+ the$searchfilter operatorsecurity.mdxsys_capabilityregistry, objectaccessposture, objectrequiredPermissionsmetadata/page.mdxresponsiveStyles(preferred styling channel)analytics-datasets.mdxconcepts/metadata-lifecycle.mdxP3 — minor / polish
platform_admin/org_owner/org_admin/org_member) added tosecurity.mdx.auth-sso.mdx: note the per-env@better-auth/ssoexternal-IdP path +features.ssopublic-config flag (ADR-0069).Scope notes
Verified not gaps (already covered or not yet shipped): ADR-0062, ADR-0057-erp-authz, ADR-0057-data-lifecycle (P0/internal), ADR-0073 (proposed/M2), ADR-0059/0060/0072 (internal). Builds on #2337 (AI-edition docs).
Docs-only. The Build Docs CI job validates the MDX.
🤖 Generated with Claude Code