Skip to content

Commit b5dfb18

Browse files
committed
docs: seat patch round — three more counts out of the skills and capabilities pages, the releases page left to a docs-only PR, every shipping package in the changeset
The releases tree is release-owned, so its one count stays for a dedicated docs-only PR. The changeset now names every package whose shipped bytes the sweep touches. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017ihL2fNkBkNQ88EMzvcrPW
1 parent 93c9b71 commit b5dfb18

6 files changed

Lines changed: 19 additions & 10 deletions

File tree

‎.changeset/27522-inventory-counts.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
---
22
'@objectstack/skills': patch
3+
'@objectstack/spec': patch
4+
'@objectstack/metadata': patch
5+
'@object-ui/i18n': patch
6+
'@object-ui/plugin-grid': patch
7+
'@object-ui/components': patch
8+
'@object-ui/fields': patch
9+
'@object-ui/types': patch
10+
'@object-ui/plugin-form': patch
11+
'@object-ui/console': patch
312
---
413

514
docs(skills): hand-written inventory counts are deleted; the names and the source of truth stay
@@ -9,4 +18,4 @@ Metadata-protocol: none
918

1019
- **Before.** `objectstack-data` counted its field types ("49") in SKILL.md and in `rules/field-types.md`, and its lifecycle events ("8") in SKILL.md and `references/data-hooks.md`; `objectstack-automation` counted its built-in node types ("20"); `objectui/README.md` counted its plugins ("18"); `objectui/guides/schema-expressions.md` counted the formula registry ("30 functions"); `objectstack-query` counted the aggregate functions ("six"). No gate reads any of those numbers against the tree, so each one goes wrong the moment the inventory moves, and a wrong count misleads the reader more than no count.
1120
- **Now.** The numbers are gone; every enumeration that taught something (the node-type tables, the plugin names, the function table, the aggregate names) stays, and each page still points at the file or schema that is the source of truth. Deletion only: every touched file shrinks under its unchanged token ceiling.
12-
- No schema, key or behaviour changes.
21+
- The same deletion in shipped READMEs and one shipped source comment: `@objectstack/spec` (a `//` comment in `src/kernel/metadata-plugin.zod.ts`, which ships), `@objectstack/metadata` (README), and the `@object-ui/*` READMEs of i18n, plugin-grid, components, fields, types, plugin-form and console. No schema, key or behaviour changes.

‎content/docs/api/error-catalog.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ navTitle: Error Code Catalog
44
description: Complete reference for all ObjectStack error codes with causes, fixes, and retry strategies
55
---
66

7-
ObjectStack uses a structured error system of **error categories** and **error codes reachable on the wire**, catalogued in full below. Every error includes a machine-readable code, HTTP status mapping, and retry guidance.
7+
ObjectStack uses a structured error system of **error categories** and **56 error codes reachable on the wire**, catalogued in full below (that count is pinned by `packages/spec/src/api/error-catalog-docs.test.ts` against the wire face). Every error includes a machine-readable code, HTTP status mapping, and retry guidance.
88

99
This catalog documents the **wire face** — the codes a client can actually receive. That is not quite the
1010
`StandardErrorCode` enum: the enum also carries in-process spellings the REST door translates at the

‎content/docs/capabilities/index.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ If you are a developer, the [Build sections](/docs/data-modeling) cover the same
1717
<Card href="/docs/capabilities/forms" title="Forms & Data Quality" description="Wizards, conditional fields, validation on save, legal stage transitions, public web-to-lead forms" />
1818
<Card href="/docs/capabilities/automation" title="Automation" description="Trigger styles and visual flows: reminders, hand-offs, escalations, and scheduled work that runs itself" />
1919
<Card href="/docs/capabilities/approvals" title="Approvals" description="Approver styles and decision modes including group sign-off, locking, SLA escalation, send-back" />
20-
<Card href="/docs/capabilities/permissions" title="Permissions — Who Sees What" description="Four layers from object capability to per-field visibility, five data-depth scopes, audit, and an explain API" />
21-
<Card href="/docs/capabilities/analytics" title="Analytics & Dashboards" description="~20 chart families, period-over-period, runtime filters, TV display pages and reports" />
20+
<Card href="/docs/capabilities/permissions" title="Permissions — Who Sees What" description="Layers from object capability to per-field visibility, data-depth scopes, audit, and an explain API" />
21+
<Card href="/docs/capabilities/analytics" title="Analytics & Dashboards" description="Chart families, period-over-period, runtime filters, TV display pages and reports" />
2222
<Card href="/docs/capabilities/ai" title="AI Under Governance" description="Ask questions and get charts; AI acts under the same permissions and audit as people; bring your own agent over MCP" />
2323
<Card href="/docs/capabilities/integrations" title="Integrations & Everyday Work" description="Import/export, generated APIs, webhooks, connectors, federated databases, marketplace templates, languages" />
2424
<Card href="/docs/capabilities/request-template" title="How to Request Features" description="A one-page template that turns business needs into configuration — hand it to your team or an AI agent" />

‎content/docs/releases/implementation-status.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This matrix is generated from actual codebase analysis and represents the curren
4242
**Notes:**
4343
- Core package provides complete microkernel implementation
4444
- Plugin system supports the `init`/`start`/`destroy` lifecycle, dependency resolution, and service injection — the `onInstall`/`onEnable`-style hook family was retired in v17 as never-implemented (#4212)
45-
- Event bus enables inter-plugin communication; `IPluginLifecycleEvents` registers the lifecycle events that actually fire, and `LifecycleEventName` soft-types `hook`/`trigger` (#4241)
45+
- Event bus enables inter-plugin communication; `IPluginLifecycleEvents` registers the 14 lifecycle events that actually fire, and `LifecycleEventName` soft-types `hook`/`trigger` (#4241)
4646
- ObjectQL serves as the **example kernel** — a reference implementation that will be modularized into plugins
4747

4848
### Data Infrastructure

‎skills/objectstack-query/SKILL.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ metadata:
2222

2323
| Surface | Shape | Legal option keys |
2424
|:--|:--|:--|
25-
| engine `find` / `findOne` | `engine.find('task', {…}, { context })` | `context`, `where`, `fields`, `orderBy`, `limit`, `offset`, `search`, `searchFields`, `expand` — **plus** the six driver passthrough keys `transaction`, `tenantId`, `tenantIds`, `timezone`, `bypassTenantAudit`, `preserveAudit` |
25+
| engine `find` / `findOne` | `engine.find('task', {…}, { context })` | `context`, `where`, `fields`, `orderBy`, `limit`, `offset`, `search`, `searchFields`, `expand` — **plus** the driver passthrough keys `transaction`, `tenantId`, `tenantIds`, `timezone`, `bypassTenantAudit`, `preserveAudit` |
2626
| engine `aggregate` | `engine.aggregate('deal', {…})` | `context`, `where`, `groupBy`, `aggregations`, `having`, `timezone`, `search`, `searchFields` — the two search keys filter the input rows **before** grouping, AND-ed with `where`, exactly as on `find` |
2727
| engine `count` | `engine.count('task', {…})` | `context`, `where` |
2828
| protocol / REST | `findData({ object: 'task', query: {…} })` | `object` sits OUTSIDE the query |

‎skills/objectui/guides/plugin-development.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ ComponentRegistry.register('my-widget', MyWidgetRenderer, {
8282
| `tags` | `string[]` | Free-form grouping tags |
8383
| `description` | `string` | Longer description for the designer |
8484

85-
Sixteen keys in total: the eleven on `ComponentMeta` (`@object-ui/types`
86-
`base.ts`) plus the five `RegistryComponentMetaExtras` the registry adds
85+
The keys in total: those on `ComponentMeta` (`@object-ui/types`
86+
`base.ts`) plus the `RegistryComponentMetaExtras` the registry adds
8787
(`tier`, `namespace`, `skipFallback`, `labelling`, `deprecated`).
8888

8989
### ComponentInput types
@@ -98,8 +98,8 @@ const controlTypes: ComponentInputControlType[] = [
9898
'color', 'date', 'code', 'file', 'slot',
9999
];
100100

101-
// A manifest's inputs, checked against the published type. SIX keys are
102-
// writable — `name`, `type`, `of`, `required`, `enum`, `description`.
101+
// A manifest's inputs, checked against the published type. The writable
102+
// keys — `name`, `type`, `of`, `required`, `enum`, `description`.
103103
const inputs: ComponentInput[] = [
104104
{ name: 'title', type: 'string', required: true, description: 'Heading text' },
105105
// ONE control type, or an ARRAY of them when the input accepts several

0 commit comments

Comments
 (0)