Skip to content

Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-sam merged 4 commits into from
Sep 1, 2026
Merged

Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments #13794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
505d711
Select an import-list doc block as module description only on an expl…
claude Aug 31, 2026
a78e387
Move the eight wedged doc blocks back to the declarations they document
claude Aug 31, 2026
3f4d5c7
merge origin/main (os-regen artifacts taken from main; regeneration f…
claude Aug 31, 2026
b25f061
regenerate ui/component reference page on the merged tree
claude Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .changeset/module-doc-block-selection.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.
2 changes: 0 additions & 2 deletions content/docs/references/ai/agent.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down
3 changes: 0 additions & 3 deletions content/docs/references/data/datasource.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down
3 changes: 0 additions & 3 deletions content/docs/references/data/hook.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down
8 changes: 0 additions & 8 deletions content/docs/references/security/permission.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down
2 changes: 2 additions & 0 deletions content/docs/references/shared/mapping.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down
2 changes: 2 additions & 0 deletions content/docs/references/system/cache.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down
33 changes: 0 additions & 33 deletions content/docs/references/ui/action.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
runtime resolves the field's label (i18n), type, validation rules,
options, placeholder, help text, and widget mapping from object
metadata. Cross-object references use `objectOverride`.

```ts
params: [
{ field: 'email' }, // same object
{ field: 'role', objectOverride: 'sys_member' }, // different object
]
```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
inline when no matching object field exists. Inline values may also be
used alongside `field` to override individual properties. A `lookup` /
`master_detail` param declared this way MUST name its target object via
`reference` — there is no field to inherit it from:

```ts
params: [
{ name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
]
```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down
15 changes: 0 additions & 15 deletions content/docs/references/ui/app.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down
2 changes: 0 additions & 2 deletions content/docs/references/ui/component.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down
3 changes: 0 additions & 3 deletions content/docs/references/ui/page.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments by os-warren · Pull Request #13794 · objectstack-ai/objectstack · GitHub
Skip to content
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-sam
merged 4 commits into

from

Sep 1, 2026
 Merged


Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments
#13794
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
505d711

Select an import-list doc block as module description only on an expl…


claude Aug 31, 2026
a78e387

Move the eight wedged doc blocks back to the declarations they document


claude Aug 31, 2026
3f4d5c7

merge origin/main (os-regen artifacts taken from main; regeneration f…


claude Aug 31, 2026
b25f061

regenerate ui/component reference page on the merged tree


claude Aug 31, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 15 additions & 0 deletions
.changeset/module-doc-block-selection.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.

2 changes: 0 additions & 2 deletions
content/docs/references/ai/agent.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/datasource.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/hook.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down

8 changes: 0 additions & 8 deletions
content/docs/references/security/permission.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/shared/mapping.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/system/cache.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down

33 changes: 0 additions & 33 deletions
content/docs/references/ui/action.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
 runtime resolves the field's label (i18n), type, validation rules,
 options, placeholder, help text, and widget mapping from object
 metadata. Cross-object references use `objectOverride`.

 ```ts
 params: [
 { field: 'email' }, // same object
 { field: 'role', objectOverride: 'sys_member' }, // different object
 ]
 ```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
 inline when no matching object field exists. Inline values may also be
 used alongside `field` to override individual properties. A `lookup` /
 `master_detail` param declared this way MUST name its target object via
 `reference` — there is no field to inherit it from:

 ```ts
 params: [
 { name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
 ]
 ```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down

15 changes: 0 additions & 15 deletions
content/docs/references/ui/app.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down

2 changes: 0 additions & 2 deletions
content/docs/references/ui/component.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/ui/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments by os-warren · Pull Request #13794 · objectstack-ai/objectstack · GitHub
Skip to content
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-sam
merged 4 commits into

from

Sep 1, 2026
 Merged


Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments
#13794
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
505d711

Select an import-list doc block as module description only on an expl…


claude Aug 31, 2026
a78e387

Move the eight wedged doc blocks back to the declarations they document


claude Aug 31, 2026
3f4d5c7

merge origin/main (os-regen artifacts taken from main; regeneration f…


claude Aug 31, 2026
b25f061

regenerate ui/component reference page on the merged tree


claude Aug 31, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 15 additions & 0 deletions
.changeset/module-doc-block-selection.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.

2 changes: 0 additions & 2 deletions
content/docs/references/ai/agent.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/datasource.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/hook.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down

8 changes: 0 additions & 8 deletions
content/docs/references/security/permission.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/shared/mapping.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/system/cache.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down

33 changes: 0 additions & 33 deletions
content/docs/references/ui/action.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
 runtime resolves the field's label (i18n), type, validation rules,
 options, placeholder, help text, and widget mapping from object
 metadata. Cross-object references use `objectOverride`.

 ```ts
 params: [
 { field: 'email' }, // same object
 { field: 'role', objectOverride: 'sys_member' }, // different object
 ]
 ```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
 inline when no matching object field exists. Inline values may also be
 used alongside `field` to override individual properties. A `lookup` /
 `master_detail` param declared this way MUST name its target object via
 `reference` — there is no field to inherit it from:

 ```ts
 params: [
 { name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
 ]
 ```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down

15 changes: 0 additions & 15 deletions
content/docs/references/ui/app.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down

2 changes: 0 additions & 2 deletions
content/docs/references/ui/component.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/ui/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments by os-warren · Pull Request #13794 · objectstack-ai/objectstack · GitHub
Skip to content
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-sam
merged 4 commits into

from

Sep 1, 2026
 Merged


Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments
#13794
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
505d711

Select an import-list doc block as module description only on an expl…


claude Aug 31, 2026
a78e387

Move the eight wedged doc blocks back to the declarations they document


claude Aug 31, 2026
3f4d5c7

merge origin/main (os-regen artifacts taken from main; regeneration f…


claude Aug 31, 2026
b25f061

regenerate ui/component reference page on the merged tree


claude Aug 31, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 15 additions & 0 deletions
.changeset/module-doc-block-selection.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.

2 changes: 0 additions & 2 deletions
content/docs/references/ai/agent.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/datasource.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/hook.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down

8 changes: 0 additions & 8 deletions
content/docs/references/security/permission.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/shared/mapping.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/system/cache.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down

33 changes: 0 additions & 33 deletions
content/docs/references/ui/action.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
 runtime resolves the field's label (i18n), type, validation rules,
 options, placeholder, help text, and widget mapping from object
 metadata. Cross-object references use `objectOverride`.

 ```ts
 params: [
 { field: 'email' }, // same object
 { field: 'role', objectOverride: 'sys_member' }, // different object
 ]
 ```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
 inline when no matching object field exists. Inline values may also be
 used alongside `field` to override individual properties. A `lookup` /
 `master_detail` param declared this way MUST name its target object via
 `reference` — there is no field to inherit it from:

 ```ts
 params: [
 { name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
 ]
 ```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down

15 changes: 0 additions & 15 deletions
content/docs/references/ui/app.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down

2 changes: 0 additions & 2 deletions
content/docs/references/ui/component.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/ui/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments by os-warren · Pull Request #13794 · objectstack-ai/objectstack · GitHub
Skip to content
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-sam
merged 4 commits into

from

Sep 1, 2026
 Merged


Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments
#13794
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
505d711

Select an import-list doc block as module description only on an expl…


claude Aug 31, 2026
a78e387

Move the eight wedged doc blocks back to the declarations they document


claude Aug 31, 2026
3f4d5c7

merge origin/main (os-regen artifacts taken from main; regeneration f…


claude Aug 31, 2026
b25f061

regenerate ui/component reference page on the merged tree


claude Aug 31, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 15 additions & 0 deletions
.changeset/module-doc-block-selection.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.

2 changes: 0 additions & 2 deletions
content/docs/references/ai/agent.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/datasource.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/hook.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down

8 changes: 0 additions & 8 deletions
content/docs/references/security/permission.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/shared/mapping.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/system/cache.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down

33 changes: 0 additions & 33 deletions
content/docs/references/ui/action.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
 runtime resolves the field's label (i18n), type, validation rules,
 options, placeholder, help text, and widget mapping from object
 metadata. Cross-object references use `objectOverride`.

 ```ts
 params: [
 { field: 'email' }, // same object
 { field: 'role', objectOverride: 'sys_member' }, // different object
 ]
 ```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
 inline when no matching object field exists. Inline values may also be
 used alongside `field` to override individual properties. A `lookup` /
 `master_detail` param declared this way MUST name its target object via
 `reference` — there is no field to inherit it from:

 ```ts
 params: [
 { name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
 ]
 ```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down

15 changes: 0 additions & 15 deletions
content/docs/references/ui/app.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down

2 changes: 0 additions & 2 deletions
content/docs/references/ui/component.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/ui/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments by os-warren · Pull Request #13794 · objectstack-ai/objectstack · GitHub
Skip to content
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-sam
merged 4 commits into

from

Sep 1, 2026
 Merged


Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments
#13794
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
505d711

Select an import-list doc block as module description only on an expl…


claude Aug 31, 2026
a78e387

Move the eight wedged doc blocks back to the declarations they document


claude Aug 31, 2026
3f4d5c7

merge origin/main (os-regen artifacts taken from main; regeneration f…


claude Aug 31, 2026
b25f061

regenerate ui/component reference page on the merged tree


claude Aug 31, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 15 additions & 0 deletions
.changeset/module-doc-block-selection.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.

2 changes: 0 additions & 2 deletions
content/docs/references/ai/agent.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/datasource.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/hook.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down

8 changes: 0 additions & 8 deletions
content/docs/references/security/permission.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/shared/mapping.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/system/cache.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down

33 changes: 0 additions & 33 deletions
content/docs/references/ui/action.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
 runtime resolves the field's label (i18n), type, validation rules,
 options, placeholder, help text, and widget mapping from object
 metadata. Cross-object references use `objectOverride`.

 ```ts
 params: [
 { field: 'email' }, // same object
 { field: 'role', objectOverride: 'sys_member' }, // different object
 ]
 ```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
 inline when no matching object field exists. Inline values may also be
 used alongside `field` to override individual properties. A `lookup` /
 `master_detail` param declared this way MUST name its target object via
 `reference` — there is no field to inherit it from:

 ```ts
 params: [
 { name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
 ]
 ```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down

15 changes: 0 additions & 15 deletions
content/docs/references/ui/app.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down

2 changes: 0 additions & 2 deletions
content/docs/references/ui/component.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/ui/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments by os-warren · Pull Request #13794 · objectstack-ai/objectstack · GitHub
Skip to content
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-sam
merged 4 commits into

from

Sep 1, 2026
 Merged


Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments
#13794
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
505d711

Select an import-list doc block as module description only on an expl…


claude Aug 31, 2026
a78e387

Move the eight wedged doc blocks back to the declarations they document


claude Aug 31, 2026
3f4d5c7

merge origin/main (os-regen artifacts taken from main; regeneration f…


claude Aug 31, 2026
b25f061

regenerate ui/component reference page on the merged tree


claude Aug 31, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 15 additions & 0 deletions
.changeset/module-doc-block-selection.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.

2 changes: 0 additions & 2 deletions
content/docs/references/ai/agent.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/datasource.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/hook.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down

8 changes: 0 additions & 8 deletions
content/docs/references/security/permission.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/shared/mapping.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/system/cache.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down

33 changes: 0 additions & 33 deletions
content/docs/references/ui/action.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
 runtime resolves the field's label (i18n), type, validation rules,
 options, placeholder, help text, and widget mapping from object
 metadata. Cross-object references use `objectOverride`.

 ```ts
 params: [
 { field: 'email' }, // same object
 { field: 'role', objectOverride: 'sys_member' }, // different object
 ]
 ```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
 inline when no matching object field exists. Inline values may also be
 used alongside `field` to override individual properties. A `lookup` /
 `master_detail` param declared this way MUST name its target object via
 `reference` — there is no field to inherit it from:

 ```ts
 params: [
 { name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
 ]
 ```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down

15 changes: 0 additions & 15 deletions
content/docs/references/ui/app.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down

2 changes: 0 additions & 2 deletions
content/docs/references/ui/component.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/ui/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments by os-warren · Pull Request #13794 · objectstack-ai/objectstack · GitHub
Skip to content
Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments#13794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

os-sam
merged 4 commits into

from

Sep 1, 2026
 Merged


Select an import-list doc block as module description only on an explicit @module marker, and re-attach the eight wedged schema comments
#13794
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
505d711

Select an import-list doc block as module description only on an expl…


claude Aug 31, 2026
a78e387

Move the eight wedged doc blocks back to the declarations they document


claude Aug 31, 2026
3f4d5c7

merge origin/main (os-regen artifacts taken from main; regeneration f…


claude Aug 31, 2026
b25f061

regenerate ui/component reference page on the merged tree


claude Aug 31, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


15 changes: 15 additions & 0 deletions
.changeset/module-doc-block-selection.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
---
'@objectstack/spec': patch
---

Reference pages and skill indexes no longer open with one schema's comment: a
doc block sitting inside a module's import list is selected as the module
description only when it carries an explicit `@module` marker. The two genuine
headers in that position (`shared/mapping`, `system/cache`) now carry the
marker; the eight modules whose "description" was a detached symbol comment
(`ai/agent`, `data/datasource`, `data/hook`, `security/permission`,
`ui/action`, `ui/app`, `ui/component`, `ui/page`) had the comment moved back to
the declaration it documents — restoring editor hover for
`AIModelConfigSchema`, `DriverType`, `ActionParamSchema` and
`PageRegionSchema` — and their pages honestly print no module description
instead of a wrong one. No schema behavior changes.

2 changes: 0 additions & 2 deletions
content/docs/references/ai/agent.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Agent protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

AI Model Configuration

<Callout type="info">
**Source:** `packages/spec/src/ai/agent.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/datasource.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Datasource protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Driver Identifier
Can be a built-in driver or a plugin-contributed driver (e.g., "com.vendor.snowflake").

<Callout type="info">
**Source:** `packages/spec/src/data/datasource.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/data/hook.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Hook protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Hook Lifecycle Events
Defines the interception points in the ObjectQL execution pipeline.

<Callout type="info">
**Source:** `packages/spec/src/data/hook.zod.ts`
</Callout>
Expand Down

8 changes: 0 additions & 8 deletions
content/docs/references/security/permission.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,14 +5,6 @@ description: Permission protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Entity (Object) Level Permissions
Defines CRUD + VAMA (View All / Modify All) + Lifecycle access.

Refined with enterprise data lifecycle controls:
- Transfer (Ownership change)
- Restore (Soft delete recovery)
- Purge (Hard delete / Compliance)

<Callout type="info">
**Source:** `packages/spec/src/security/permission.zod.ts`
</Callout>
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/shared/mapping.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Mapping protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module shared/mapping

Base Field Mapping Protocol

Shared by: Connector
Expand Down

2 changes: 2 additions & 0 deletions
content/docs/references/system/cache.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ description: Cache protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

@module system/cache

Application-Level Cache Protocol

Multi-tier caching strategy for application data.
Expand Down

33 changes: 0 additions & 33 deletions
content/docs/references/ui/action.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,39 +5,6 @@ description: Action protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Action Parameter Schema

Defines inputs required before executing an action.

Two declaration modes:

1. **Field-backed** (preferred) — reference an existing object field; the
 runtime resolves the field's label (i18n), type, validation rules,
 options, placeholder, help text, and widget mapping from object
 metadata. Cross-object references use `objectOverride`.

 ```ts
 params: [
 { field: 'email' }, // same object
 { field: 'role', objectOverride: 'sys_member' }, // different object
 ]
 ```

2. **Inline** (legacy / bespoke) — declare `name`, `label`, `type` etc.
 inline when no matching object field exists. Inline values may also be
 used alongside `field` to override individual properties. A `lookup` /
 `master_detail` param declared this way MUST name its target object via
 `reference` — there is no field to inherit it from:

 ```ts
 params: [
 { name: 'inspector', label: 'Inspector', type: 'lookup', reference: 'sys_user' },
 ]
 ```

`name` is required unless `field` is provided (in which case it defaults
to the field name and is used as the request-body key).

<Callout type="info">
**Source:** `packages/spec/src/ui/action.zod.ts`
</Callout>
Expand Down

15 changes: 0 additions & 15 deletions
content/docs/references/ui/app.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,21 +5,6 @@ description: App protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Base Navigation Item Schema
Shared properties for all navigation types.

**NAMING CONVENTION:**
Navigation item IDs are used in URLs and configuration and must be lowercase snake_case.

@example Good IDs
- 'menu_accounts'
- 'page_dashboard'
- 'nav_settings'

@example Bad IDs (will be rejected)
- 'MenuAccounts' (PascalCase)
- 'Page Dashboard' (spaces)

<Callout type="info">
**Source:** `packages/spec/src/ui/app.zod.ts`
</Callout>
Expand Down

2 changes: 0 additions & 2 deletions
content/docs/references/ui/component.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,8 +5,6 @@ description: Component protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Empty Properties Schema

<Callout type="info">
**Source:** `packages/spec/src/ui/component.zod.ts`
</Callout>
Expand Down

3 changes: 0 additions & 3 deletions
content/docs/references/ui/page.mdx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,9 +5,6 @@ description: Page protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

Page Region Schema
A named region in the template where components are dropped.

<Callout type="info">
**Source:** `packages/spec/src/ui/page.zod.ts`
</Callout>
Expand Down
Loading
Loading