docs: sync all package READMEs and website docs with current monorepo state#672
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…nd website docs - Create README.md for @objectstack/rest (was missing) - Create README.md for @objectstack/plugin-security (was missing) - Update root README.md: fix license badge (MIT→Apache 2.0), fix git clone URL (nicecui→objectstack-ai), add all 7 framework adapters, add plugin-security/plugin-dev/rest/create-objectstack/vscode, update schema count (139→175), fix package reference path - Update content/docs/concepts/packages.mdx: expand from 16 to 25 packages, add all 7 adapters (Express, Fastify, Hono, NestJS, Next.js, Nuxt, SvelteKit), add plugin-security/plugin-dev/rest/create-objectstack/vscode, update dependency graph, update schema count - Update content/docs/references/index.mdx: update protocol module counts and total (139→175), add Cloud and Studio protocols, remove obsolete Hub protocol - Update content/docs/guides/cheatsheets/quick-reference.mdx: update schema count (139→175) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README and official documentation for package updates
docs: sync all package READMEs and website docs with current monorepo state
Feb 13, 2026
hotlong
marked this pull request as ready for review
February 13, 2026 18:15
hotlong
approved these changes
Feb 13, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR synchronizes repository documentation with the current monorepo state, adding two missing package READMEs and updating counts/references across all documentation to reflect growth from 15→25 packages and 139→175 schemas. The updates correct outdated metadata (license badge, git URL) and comprehensively document all framework adapters and recently added packages.
Changes:
- Created READMEs for
@objectstack/restand@objectstack/plugin-securitywith accurate API documentation - Updated root README.md with corrected license badge (MIT→Apache 2.0), git URL (nicecui→objectstack-ai), and comprehensive package tables including new Framework Adapters section
- Synchronized website docs with current schema counts per protocol module and replaced obsolete Hub protocol with Cloud + Studio protocols
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/rest/README.md | New comprehensive README for REST API server package with usage examples and feature list |
| packages/plugins/plugin-security/README.md | New README documenting RBAC, RLS, and field-level security architecture with 4-step security chain |
| README.md | Updated license badge, git URL, schema count (139→175), package count (15→25), added Framework Adapters table and missing package entries |
| content/docs/concepts/packages.mdx | Updated package count to 25, added all 7 framework adapters with detailed descriptions, added plugin-security/plugin-dev/rest/create-objectstack/vscode entries, updated dependency graph |
| content/docs/references/index.mdx | Updated per-module schema counts (Data: 18→19, UI: 10→18, Kernel: 17→32, System: 22→27, AI: 13→14, API: 20→25, Shared: 4→9), replaced Hub Protocol (9) with Cloud Protocol (4) + Studio Protocol (1), updated total 139→175 |
| content/docs/guides/cheatsheets/quick-reference.mdx | Updated total schema count from 139 to 175 |
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.
Repository documentation was stale — missing 9 packages from tables, 2 packages had no README, schema counts were outdated (139→175), and several incorrect references (wrong git URL, wrong license badge).
New READMEs
packages/rest/README.md—@objectstack/rest(REST API server, was completely missing)packages/plugins/plugin-security/README.md—@objectstack/plugin-security(RBAC/RLS/field masking)Root README.md
package.json)nicecui/spec→objectstack-ai/specplugin-security,plugin-dev,@objectstack/rest,create-objectstack,objectstack-vscodeWebsite docs (
content/docs/)concepts/packages.mdx— 16 → 25 packages; added all 7 adapters,plugin-security,plugin-dev,rest,create-objectstack,objectstack-vscode; updated dependency graphreferences/index.mdx— Updated per-module schema counts to match actual*.zod.tsfiles; replaced obsolete Hub protocol with Cloud + Studioguides/cheatsheets/quick-reference.mdx— Schema count 139 → 175Original 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.