Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 17, 2026

The 683-line protocol-spec.mdx contained all protocol documentation in a single file, making it difficult to navigate and maintain. Split into four focused documents organized in a dedicated protocol-spec/ subfolder with proper navigation hierarchy showing expandable second-level menu.

Changes

  • Created protocol-spec/ subfolder to organize specification documents

  • New documents (English + Chinese) in protocol-spec/ subfolder:

    • schema-definition.mdx - Object definitions, field types, constraints
    • query-dsl.mdx - Filters, sorting, pagination, field selection
    • aggregation.mdx - GroupBy, aggregate functions, having clause
    • mutation.mdx - Insert, update, delete, batch operations
  • Moved protocol-spec.mdx to protocol-spec/index.mdx to enable expandable navigation:

    • Protocol architecture summary
    • Links to four main components in subfolder
    • Quick start example spanning all operations
    • Enables second-level menu in sidebar
  • Updated navigation in meta.json for both language versions

  • Updated all internal links to reflect new subfolder paths

  • Created meta.json in protocol-spec subfolder for navigation

  • Security fix: Updated tj-actions/changed-files from v44 to v46.0.1 in .github/workflows/ai-translate.yml (CVE: secret exposure via action logs)

Structure

Before: Single file with all documentation

02-objectql/
├── protocol-spec.mdx (683 lines)

After: Organized in subfolder with expandable navigation

02-objectql/
└── protocol-spec/
    ├── index.mdx (overview)
    ├── meta.json
    ├── schema-definition.mdx
    ├── query-dsl.mdx
    ├── aggregation.mdx
    └── mutation.mdx

Screenshots

Protocol Specification with expandable second-level menu in sidebar:

Schema Definition page with breadcrumb navigation:

Overview page with component links:

Query DSL:

Aggregation Operations:

Mutation Operations:

Original prompt

分拆 objectql Protocol Specification


💡 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.

@vercel
Copy link

vercel bot commented Jan 17, 2026

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

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Jan 17, 2026 5:50am

Request Review

Copilot AI changed the title [WIP] Split objectql protocol specification Split ObjectQL Protocol Specification into focused documents Jan 17, 2026
Copilot AI requested a review from huangyiirene January 17, 2026 04:58
@huangyiirene
Copy link
Collaborator

应该分拆到子文件夹 @copilot

Copy link
Contributor Author

Copilot AI commented Jan 17, 2026

应该分拆到子文件夹 @copilot

Done! Moved all protocol specification files into a protocol-spec/ subfolder. The structure is now:

02-objectql/
├── protocol-spec.mdx (overview)
└── protocol-spec/
    ├── schema-definition.mdx
    ├── query-dsl.mdx
    ├── aggregation.mdx
    └── mutation.mdx

All internal links have been updated, and both English and Chinese versions follow the same structure. (662a53f)

Protocol Spec Subfolder

Copilot AI changed the title Split ObjectQL Protocol Specification into focused documents Split ObjectQL Protocol Specification into focused documents in subfolder Jan 17, 2026
@huangyiirene
Copy link
Collaborator

@copilot 左侧为什么没看到二级菜单?

Copy link
Contributor Author

Copilot AI commented Jan 17, 2026

@copilot 左侧为什么没看到二级菜单?

Fixed! Moved protocol-spec.mdx to protocol-spec/index.mdx. The second-level menu now appears in the sidebar showing all the protocol specification documents. (98560f5)

Protocol Spec with Submenu

@huangyiirene huangyiirene marked this pull request as ready for review January 17, 2026 05:34
@github-actions
Copy link

🚀 Preview Deployment

This pull request will be automatically deployed to Vercel.

Preview Links

  • 📝 Documentation: Will be available once Vercel deployment completes
  • 🌍 Languages: English (/en/docs) and Chinese (/cn/docs)

Build Status

Check the CI workflow for build status and any errors.


Automated preview information for PR #34

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 17, 2026
@huangyiirene huangyiirene merged commit 64c6cf1 into main Jan 17, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants