docs(site): ground module overviews and landing copy in verified capabilities#2593
Merged
Conversation
…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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
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)
FieldTypeenum inpackages/spec/src/data/field.zod.tstypeenum 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/graphqlroute is wired but returns 501 without a bring-your-ownIGraphQLService— no implementation ships in this repo (packages/runtime/src/http-dispatcher.ts)$top); no standalone OData endpoint existsservices.auditpresented alongside stable serviceskernel/runtime-services/versioning.mdxCopy upgrades (all claims cited from source)
defineStack()→objectstack.jsonartifact story, concrete numbers (15 protocol namespaces, 49 field types, 4 drivers), and the agent-boundary pitch.Leadobject sample (examples/app-crm/src/objects/lead.object.ts); the four shipped drivers (driver-sqlPG/MySQL/SQLite via Knex,driver-mongodb,driver-memory,driver-sqlite-wasm); vector fields with HNSW/IVFFlat config; external datasource federation (service-datasource, ADR-0015).opportunity.hook.ts); 18 hook events (9 before/after pairs,hook.zod.ts); 20 built-in flow node types, registry-extensible viaregisterNodeExecutor(ADR-0018); scheduled flows + cron job service; webhook durable outbox with exponential/linear/fixed retry, dead-lettering, HMAC signing (plugin-webhooks).own → own_and_reports → unit → unit_and_below → org; realdefineSharingRulesample (sharing-rules.ts); fixed a staleconcepts/implementation-status.mdxpath that arrived via a post-restructure merge.App.createsample (crm.app.ts); 9 view render types; portals with anonymous entry routes for public data collection; themes as metadata (CRM ships light/dark variants).services.*table with stability tiers fromversioning.mdx; 28 contract interfaces inpackages/spec/src/contracts/; 15 runtime service packages.@objectstack/spec/data,@objectstack/spec/ui).Verification
node scripts/check-doc-authoring.mjs— clean (samples use theObjectSchema.create/Field.*/defineSharingRulefactory style)next buildpasses🤖 Generated with Claude Code
https://claude.ai/code/session_018r9mjpF7jr9BKdzEmUE4uZ
Generated by Claude Code