Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 29, 2026

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring
  • Performance improvement
  • CI/CD update

Related Issues

Related to #37

Changes Made

Version References

  • Updated .github/copilot-instructions.md to reference v0.6.1
  • Added UPGRADE_NOTES.md cross-reference to main README

Runtime Architecture Documentation

  • Documented ESM compatibility blocker in packages/server/README.md
  • Added runtime dependencies section: @objectstack/core, @objectstack/runtime, @objectstack/objectql, @objectstack/driver-memory
  • Clarified migration path once upstream packages fix missing .js extensions

Metadata Format Correction

  • Fixed outdated "YAML" reference → "TypeScript" in README architecture section

English-Only Standard Enforcement

  • Translated 70+ Chinese labels and messages across:
    • .github/agents/ documentation (filter labels, field names, error messages)
    • content/docs/ examples (AI field labels, activity descriptions, validation messages)
    • Examples: 线索评分Lead Score, 客户Account, 商机Opportunity

Testing

  • Unit tests pass (npm test)
  • Linting passes (npm run lint)
  • Build succeeds (npm run build)
  • Manual testing completed
  • New tests added (if applicable)

Screenshots

N/A - Documentation-only changes

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Additional Notes

No code changes - documentation-only update. CodeQL analysis skipped (no analyzable code modified).

Original prompt

拉取请求: #37

更新所有相关文档


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

@vercel
Copy link

vercel bot commented Jan 29, 2026

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

Project Deployment Review Updated (UTC)
hotcrm Ready Ready Preview, Comment Jan 29, 2026 1:17am

Request Review

Copilot AI and others added 3 commits January 29, 2026 00:42
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>
Copilot AI and others added 3 commits January 29, 2026 00:51
- 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>
Copilot AI changed the title [WIP] Update all related documentation Update documentation for @objectstack v0.6.1 upgrade Jan 29, 2026
Copilot AI requested a review from hotlong January 29, 2026 00:56
@hotlong hotlong marked this pull request as ready for review January 29, 2026 01:04
Copilot AI review requested due to automatic review settings January 29, 2026 01:04
@github-actions github-actions bot added documentation Improvements or additions to documentation ci/cd labels Jan 29, 2026
Copy link

Copilot AI left a 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.md explaining 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

@hotlong hotlong merged commit b0cec41 into main Jan 29, 2026
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci/cd documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants