Document new manifest package types for microkernel architecture#330
Merged
Document new manifest package types for microkernel architecture#330
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update related documentation
Document new manifest package types for microkernel architecture
Jan 27, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR completes the documentation for PR #328, which extended the manifest schema with three new package types (objectql, gateway, adapter) to support ObjectStack's microkernel architecture. The documentation clearly explains the role, cardinality, and lifecycle ordering of all seven package types.
Changes:
- Updated manifest schema reference documentation to include all 7 package types
- Added comprehensive microkernel architecture documentation with package hierarchy, lifecycle ordering, and adapter/gateway distinction
- Provided developer guidance for selecting appropriate package types
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/references/kernel/manifest/Manifest.mdx | Updated type enum to include objectql, gateway, and adapter |
| content/docs/developers/writing-plugins.mdx | Added package type selection guidance with use cases for all 7 types |
| README.md | Updated manifest description to mention 7 package types |
| PROTOCOL_REFERENCE.md | Added microkernel features section with detailed package type definitions |
| ARCHITECTURE.md | Added comprehensive "Package Types & Microkernel Architecture" section with hierarchy diagram, lifecycle ordering, and adapter/gateway distinction |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR #328 extended the manifest schema with three package types (
objectql,gateway,adapter) to support microkernel architecture. Documentation was incomplete.Changes
Reference Documentation
'app' | 'plugin' | 'driver' | 'module' | 'objectql' | 'gateway' | 'adapter'Architecture Documentation
adapter → gateway → kernel → objectql → driver → databaseDeveloper Guides
Package Type Definitions
adaptergatewayobjectqldriverKey distinction: adapter = runtime host (Express vs Hono), gateway = protocol (GraphQL vs REST). Multiple gateways can coexist on one adapter.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.