Add missing documentation for core protocol schemas#442
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation based on recent changes
Add missing documentation for core protocol schemas
Jan 31, 2026
hotlong
approved these changes
Jan 31, 2026
github-actions
bot
added
the
documentation
Contributor
|
This PR is very large. Consider breaking it into smaller PRs for easier review. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for 8 critical protocol schemas that were previously undocumented, following PR #441 which introduced 110+ schema files. The documentation provides detailed schema references, TypeScript examples, property tables, usage patterns, and best practices.
Changes:
- Added 8 new documentation files (2,325 lines) covering data, system, and integration protocols
- Fixed structural issues: removed duplicate
data/search-engine.mdxand corrected source path inautomation/connector.mdx - Updated navigation metadata files for proper documentation indexing
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
system/startup-orchestrator.mdx |
Documents plugin startup orchestration with health checks, rollback, and parallelization |
system/service-registry.mdx |
Documents DI container with singleton/transient/scoped service patterns |
system/plugin-validator.mdx |
Documents plugin validation with comprehensive error code registry |
system/plugin-lifecycle-events.mdx |
Documents kernel/plugin/service/hook lifecycle event schemas |
system/metadata-loader.mdx |
Documents multi-backend metadata loading from FS/HTTP/S3/DB |
data/driver-postgres.mdx |
Documents PostgreSQL connection config including SSL and pooling |
data/driver-mongo.mdx |
Documents MongoDB connection config with replica sets and capabilities |
integration/connector-file-storage.mdx |
Documents S3/Azure/GCS connector with multipart uploads and versioning |
data/search-engine.mdx |
Removed duplicate (correct version exists in system/search-engine.mdx) |
automation/connector.mdx |
Fixed source path reference from automation/ to integration/ |
data/meta.json |
Added navigation entries for new driver documentation |
integration/meta.json |
Added navigation entry for file storage connector |
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.
Recent codebase addition (PR #441) introduced 110+ schema files. This PR closes documentation gaps for 8 critical schemas and fixes structural issues.
New Documentation (8 files, 2,325 lines)
Data Protocol
driver-postgres.mdx- PostgreSQL connection config (SSL, pooling, timeouts)driver-mongo.mdx- MongoDB connection config (replica sets, auth, capabilities)System Protocol
plugin-lifecycle-events.mdx- Event schemas for kernel/plugin/service/hook lifecyclestartup-orchestrator.mdx- Plugin startup with health checks, rollback, parallelizationplugin-validator.mdx- Validation errors/warnings with error code registrymetadata-loader.mdx- Multi-backend metadata loading (FS, HTTP, S3, DB)service-registry.mdx- DI container with singleton/transient/scoped servicesIntegration Protocol
connector-file-storage.mdx- S3/Azure/GCS connector with multipart uploads, versioningFixes
data/search-engine.mdx(correct version insystem/)automation/connector.mdxsource path reference (automation → integration)data/meta.jsonandintegration/meta.jsonfor navigationEach file includes Zod schema references, TypeScript examples, property tables, usage patterns, and best practices.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.