Skip to content

docs(site): ground module overviews and landing copy in verified capabilities#2593

Merged
os-zhuang merged 1 commit into
mainfrom
claude/docs-site-structure-w9lfzp
Jul 4, 2026
Merged

docs(site): ground module overviews and landing copy in verified capabilities#2593
os-zhuang merged 1 commit into
mainfrom
claude/docs-site-structure-w9lfzp

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Deep copy pass grounded in the actual implementation

Follow-up to #2584 (module-first IA restructure). This PR upgrades the copy on the docs entry pages — the landing page and the module overviews — so that every capability claim is verified against the source and every module opens with a real, runnable-style code sample taken from examples/app-crm.

Fact corrections (docs vs implementation)

Claim in docs Reality (evidence) Fix
"44" / "40+" / "48" field types (three inconsistent counts) 49 — counted from the FieldType enum in packages/spec/src/data/field.zod.ts Standardized to 49 everywhere
Views described as "list/form/kanban/calendar" List-view type enum has 9 render types: grid, kanban, gallery, calendar, timeline, gantt, map, chart, tree (packages/spec/src/ui/view.zod.ts); forms are a separate view kind UI overview now uses the spec vocabulary
GraphQL implied as a served surface /graphql route is wired but returns 501 without a bring-your-own IGraphQLService — no implementation ships in this repo (packages/runtime/src/http-dispatcher.ts) API overview gets an honest "surfaces at a glance" table
OData reads like a live endpoint Vocabulary only — REST borrows OData operators ($top); no standalone OData endpoint exists Same table
services.audit presented alongside stable services It is experimental per kernel/runtime-services/versioning.mdx Stability column in the kernel overview

Copy upgrades (all claims cited from source)

  • Landing — the defineStack()objectstack.json artifact story, concrete numbers (15 protocol namespaces, 49 field types, 4 drivers), and the agent-boundary pitch.
  • Data Modeling — real Lead object sample (examples/app-crm/src/objects/lead.object.ts); the four shipped drivers (driver-sql PG/MySQL/SQLite via Knex, driver-mongodb, driver-memory, driver-sqlite-wasm); vector fields with HNSW/IVFFlat config; external datasource federation (service-datasource, ADR-0015).
  • Automation — real hook sample (opportunity.hook.ts); 18 hook events (9 before/after pairs, hook.zod.ts); 20 built-in flow node types, registry-extensible via registerNodeExecutor (ADR-0018); scheduled flows + cron job service; webhook durable outbox with exponential/linear/fixed retry, dead-lettering, HMAC signing (plugin-webhooks).
  • Permissions & Identity — five-layer model summary (profiles / permission sets / role hierarchy / sharing+OWD / RLS / FLS, each with its runtime package); object access scopes own → own_and_reports → unit → unit_and_below → org; real defineSharingRule sample (sharing-rules.ts); fixed a stale concepts/implementation-status.mdx path that arrived via a post-restructure merge.
  • UI Engine — real App.create sample (crm.app.ts); 9 view render types; portals with anonymous entry routes for public data collection; themes as metadata (CRM ships light/dark variants).
  • Kernel & Servicesservices.* table with stability tiers from versioning.mdx; 28 contract interfaces in packages/spec/src/contracts/; 15 runtime service packages.
  • Code sample import paths match the real example app (@objectstack/spec/data, @objectstack/spec/ui).

Verification

  • node scripts/check-doc-authoring.mjs — clean (samples use the ObjectSchema.create / Field.* / defineSharingRule factory style)
  • Full next build passes
  • Capability facts compiled by a source-inspection sweep with file-path evidence for each claim; the five contradictions found are the fact-correction table above

🤖 Generated with Claude Code

https://claude.ai/code/session_018r9mjpF7jr9BKdzEmUE4uZ


Generated by Claude Code

…bilities

Deep copy pass over the landing page and module overviews, with every
claim verified against the implementation (file-level citations in the
PR body):

- standardize the field-type count to the actual 49 (docs previously
  said 44, 40+, and 48 in different places)
- data-modeling: real Lead object sample from examples/app-crm; name
  the four shipped drivers; call out vector fields, CEL validation
  with previous.<field>, and external federation
- automation: real hook sample; precise counts (18 hook events, 20
  built-in + registry-extensible flow node types); durable webhook
  outbox semantics (retry/backoff/dead-letter, HMAC)
- permissions: five-layer model summary with access scopes; real
  defineSharingRule sample; stale implementation-status path fixed
- ui: correct the view vocabulary to the spec's 9 render types (grid,
  kanban, gallery, calendar, timeline, gantt, map, chart, tree); real
  App.create sample; portals with anonymous entry routes
- kernel: services.* table with stability tiers from versioning.mdx;
  28 contracts / 15 service packages
- api: 'surfaces at a glance' table that is honest about GraphQL
  (BYO service, 501 without one) and OData (vocabulary only)
- landing: defineStack -> artifact story, concrete numbers

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018r9mjpF7jr9BKdzEmUE4uZ
@vercel

vercel Bot commented Jul 4, 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 Jul 4, 2026 3:59pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/m labels Jul 4, 2026
@os-zhuang os-zhuang marked this pull request as ready for review July 4, 2026 17:28
@os-zhuang os-zhuang merged commit d13dc5c into main Jul 4, 2026
15 checks passed
@os-zhuang os-zhuang deleted the claude/docs-site-structure-w9lfzp branch July 4, 2026 17:28
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.

2 participants