-
Notifications
You must be signed in to change notification settings - Fork 0
Update documentation for @objectstack v0.6.1 upgrade #38
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.
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…notes Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…tion Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
- Translated field labels in code examples (e.g., '线索评分' -> 'Lead Score') - Translated error messages and descriptions to English - Translated UI labels and validation messages - Updated object definitions, hooks, and API examples - Maintained exact structure and formatting Files updated: - content/docs/ai/capabilities.mdx - content/docs/ai/overview.mdx - content/docs/api-reference/rest-api.mdx - content/docs/development/business-logic.mdx - content/docs/development/creating-objects.mdx All documentation now follows English-only standard as per project guidelines.
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR synchronizes documentation following the @objectstack v0.6.1 upgrade from PR#37. It updates version references throughout the codebase, documents the runtime architecture migration status, corrects outdated metadata format references, and enforces the English-only documentation standard by translating 70+ Chinese labels and messages to English.
Changes:
- Updated version references from generic "@objectstack/spec" to "@objectstack/spec v0.6.1" in GitHub Copilot instructions and README
- Added comprehensive runtime architecture documentation to
packages/server/README.mdexplaining ESM compatibility blockers and migration path - Corrected metadata format reference from "YAML" to "TypeScript" in README architecture section
- Translated all Chinese labels, field names, error messages, and descriptions to English across documentation files (
.github/agents/,content/docs/)
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.github/copilot-instructions.md |
Updated version references to v0.6.1 in protocol description and schema references |
README.md |
Added UPGRADE_NOTES.md cross-reference and corrected metadata format from YAML to TypeScript |
packages/server/README.md |
Added runtime architecture section documenting ESM compatibility issues and runtime dependencies (core, runtime, objectql, driver-memory) |
content/docs/development/creating-objects.mdx |
Translated 70+ Chinese labels to English (e.g., "客户" → "Account", "商机" → "Opportunity", "线索评分" → "Lead Score") |
content/docs/development/business-logic.mdx |
Translated Chinese activity subjects, descriptions, and error messages to English |
content/docs/api-reference/rest-api.mdx |
Translated API response examples from Chinese to English |
content/docs/ai/overview.mdx |
Translated AI field labels and descriptions to English |
content/docs/ai/capabilities.mdx |
Translated AI capability field labels and descriptions to English |
.github/agents/ui-developer.md |
Translated UI filter labels from Chinese to English |
.github/agents/metadata-developer.md |
Translated field label example from Chinese to English |
.github/agents/business-logic-agent.md |
Translated error messages from Chinese to English |
Description
Post-merge documentation sync for PR#37's @objectstack v0.6.1 upgrade. Addresses version references, runtime architecture status, and enforces English-only standard across all documentation.
Type of Change
Related Issues
Related to #37
Changes Made
Version References
.github/copilot-instructions.mdto reference v0.6.1Runtime Architecture Documentation
packages/server/README.md@objectstack/core,@objectstack/runtime,@objectstack/objectql,@objectstack/driver-memory.jsextensionsMetadata Format Correction
English-Only Standard Enforcement
.github/agents/documentation (filter labels, field names, error messages)content/docs/examples (AI field labels, activity descriptions, validation messages)线索评分→Lead Score,客户→Account,商机→OpportunityTesting
npm test)npm run lint)npm run build)Screenshots
N/A - Documentation-only changes
Checklist
Additional Notes
No code changes - documentation-only update. CodeQL analysis skipped (no analyzable code modified).
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.