Consolidate root markdown files into structured docs hierarchy by Copilot · Pull Request #336 · objectstack-ai/framework

Copilot · 2026-01-28T04:22:48Z

Root directory contained 18 markdown files with scattered documentation. Consolidated into content/docs/ structure, retaining only essential repository files.

Changes

New documentation pages:

content/docs/developers/mini-kernel.mdx - Consolidated 5 MINI_KERNEL_*.md files + ADVANCED_FEATURES.md + OBJECTQL_PLUGIN_QUICKSTART.md into comprehensive plugin architecture guide
content/docs/references/index.mdx - Protocol reference index (70 protocols across 11 modules), merged from PROTOCOL_INDEX.md + PROTOCOL_REFERENCE.md
content/docs/introduction/releases.mdx - Latest features and protocol extensions, migrated from PROTOCOL_EXTENSIONS_COMPLETED.md

Simplified root:

README.md - Reduced from 190 to 75 lines, now points to docs
Removed 14 redundant markdown files
Retained essential files: README, CONTRIBUTING, CODE_OF_CONDUCT, CHANGELOG, RELEASE_NOTES, LICENSE

Navigation updates:

Added mini-kernel to developers/meta.json
Added releases to introduction/meta.json

Structure

Root: 18 files → 6 files (essential only)

content/docs/
├── introduction/releases.mdx     ← NEW
├── developers/mini-kernel.mdx    ← NEW
└── references/index.mdx          ← NEW

All content preserved. No broken links. Documentation site structure unchanged (605 files intact).

Original prompt

整理根目录markdown，必要的内容更新到docs对应的章节

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

vercel · 2026-01-28T04:22:53Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
spec	Ready	Preview, Comment	Jan 28, 2026 4:32am

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot

Pull request overview

Consolidates scattered root-level markdown documentation into the existing content/docs/ hierarchy, simplifying the repository root while preserving documentation content and navigation.

Changes:

Removed multiple root markdown docs (protocol indexes, architecture, mini-kernel docs, optimization plans) in favor of structured MDX pages under content/docs/.
Added new consolidated docs pages for protocol reference, mini-kernel architecture, and releases/updates.
Updated docs navigation (meta.json) and simplified README.md to point readers to the docs site structure.

Reviewed changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
docs-structure-proposal.md	Removes now-obsolete proposal doc from root.
content/docs/references/index.mdx	Adds consolidated “Protocol Reference” landing page covering all protocol modules.
content/docs/introduction/releases.mdx	Adds releases/updates page migrated from prior root docs.
content/docs/introduction/meta.json	Adds `releases` to introduction navigation.
content/docs/developers/mini-kernel.mdx	Adds consolidated MiniKernel architecture guide.
content/docs/developers/meta.json	Adds `mini-kernel` to developer navigation.
README.md	Simplifies README and points users to docs content and key links.
PROTOCOL_REFERENCE.md	Removes root protocol reference in favor of docs hierarchy.
PROTOCOL_ORGANIZATION.md	Removes root protocol organization doc in favor of docs hierarchy.
PROTOCOL_OPTIMIZATION_PLAN.md	Removes root optimization plan doc in favor of docs hierarchy.
PROTOCOL_INDEX.md	Removes root protocol index doc in favor of docs hierarchy.
PROTOCOL_EXTENSIONS_COMPLETED.md	Removes root protocol extensions completion report in favor of docs hierarchy.
OBJECTQL_PLUGIN_QUICKSTART.md	Removes root quickstart doc in favor of consolidated docs pages.
MINI_KERNEL_SUMMARY.md	Removes root mini-kernel summary doc in favor of consolidated docs pages.
MINI_KERNEL_INDEX.md	Removes root mini-kernel index doc in favor of consolidated docs pages.
MINI_KERNEL_IMPLEMENTATION.md	Removes root mini-kernel implementation doc in favor of consolidated docs pages.
MINI_KERNEL_GUIDE.md	Removes root mini-kernel guide doc in favor of consolidated docs pages.
MINI_KERNEL_ARCHITECTURE.md	Removes root mini-kernel architecture doc in favor of consolidated docs pages.
ARCHITECTURE.md	Removes root architecture doc in favor of docs hierarchy.
ADVANCED_FEATURES.md	Removes root advanced features doc in favor of consolidated docs pages.

Copilot · 2026-01-28T04:54:28Z

+// Query by semantic similarity
+const similarArticles = await ql.query({
+  from: 'knowledge_article',
+  where: [
+    {
+      field: 'content_embedding',
+      operator: 'similar_to',
+      value: queryEmbedding,
+      threshold: 0.8, // Cosine similarity threshold
+    },
+  ],
+  limit: 5,
+});


The vector search example calls ql.query(...) (and references queryEmbedding) without defining where ql/queryEmbedding come from. Please make the snippet self-contained (e.g., show creating an ObjectQL instance or kernel.getService('objectql'), and show how the embedding is produced/passed in).

Copilot · 2026-01-28T04:54:29Z

+// Query by distance
+const nearbyStores = await ql.query({
+  from: 'store',
+  where: [
+    {
+      field: 'location',
+      operator: 'within_radius',
+      value: {
+        lat: 37.7749,
+        lng: -122.4194,
+        radius: 10, // kilometers
+      },
+    },
+  ],
+  orderBy: [
+    {
+      field: 'location',
+      direction: 'distance_from',
+      value: { lat: 37.7749, lng: -122.4194 },
+    },
+  ],
+});
+```


The geospatial example also uses ql.query(...) without showing how ql is obtained/initialized. Please make the example runnable by including the ObjectQL initialization (or kernel usage) in the snippet, consistent with earlier examples.

Copilot · 2026-01-28T04:54:29Z

+const kernel = new ObjectKernel();
+
+for (const pluginDef of config.plugins) {
+  const PluginClass = await import(pluginDef.name);


The config-driven loading example is not valid as written: pluginDef.name values like @objectstack/runtime#ObjectQLPlugin are not valid module specifiers for import(), and await import(...) returns a module object (not a constructor). Please update the snippet to reflect the actual loader implementation (e.g., split pkg#Export, const mod = await import(pkg), then const PluginClass = mod[Export]).

Suggested change

const PluginClass = await import(pluginDef.name);

const [pkg, exportName] = pluginDef.name.split('#');

const mod = await import(pkg);

const PluginClass = exportName ? mod[exportName] : mod.default;

Copilot · 2026-01-28T04:54:29Z

 ## 📄 License

-Apach2 2.0 © ObjectStack
+Apache 2.0 © ObjectStack


The README states the project is under Apache 2.0 here, but the badge at the top still advertises an MIT license. Please update the license badge/link to match the repository license to avoid confusing users.

Initial plan

ff0ced2

Copilot AI assigned Copilot and hotlong Jan 28, 2026

Copilot started work on behalf of hotlong January 28, 2026 04:23 View session

vercel bot deployed to Preview January 28, 2026 04:25 View deployment

Copilot AI and others added 3 commits January 28, 2026 04:27

Add mini-kernel docs, protocol reference index, and simplify README

d66eedc

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Add releases page with protocol extensions and update navigation

5087cae

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Remove redundant markdown files from root directory

d709ecc

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Update root directory markdown and sync with docs~~ Consolidate root markdown files into structured docs hierarchy Jan 28, 2026

Copilot AI requested a review from hotlong January 28, 2026 04:32

Copilot finished work on behalf of hotlong January 28, 2026 04:32

vercel bot deployed to Preview January 28, 2026 04:32 View deployment

hotlong marked this pull request as ready for review January 28, 2026 04:49

Copilot AI review requested due to automatic review settings January 28, 2026 04:49

hotlong merged commit 09870f6 into main Jan 28, 2026
2 checks passed

Copilot started reviewing on behalf of hotlong January 28, 2026 04:49 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consolidate root markdown files into structured docs hierarchy#336

Consolidate root markdown files into structured docs hierarchy#336
hotlong merged 4 commits intomainfrom
copilot/update-root-markdown

Copilot AI commented Jan 28, 2026 •

edited

Loading

Uh oh!

vercel bot commented Jan 28, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Copilot AI Jan 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-  const PluginClass = await import(pluginDef.name);
+  const [pkg, exportName] = pluginDef.name.split('#');
+  const mod = await import(pkg);
+  const PluginClass = exportName ? mod[exportName] : mod.default;

Conversation

Copilot AI commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Structure

Uh oh!

vercel bot commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 28, 2026 •

edited

Loading

vercel bot commented Jan 28, 2026 •

edited

Loading