-
Notifications
You must be signed in to change notification settings - Fork 0
Remove numeric prefixes from documentation URLs #36
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: huangyiirene <[email protected]>
🚀 Preview DeploymentThis pull request will be automatically deployed to Vercel. Preview Links
Build StatusCheck the CI workflow for build status and any errors. Automated preview information for PR #36 |
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 removes numeric prefixes from all documentation URLs to create cleaner, more intuitive paths. The changes rename directories from numbered formats (00-framework, 02-objectql, 03-objectui, 04-objectos) to their simple names (framework, objectql, objectui, objectos) and update all internal documentation references accordingly.
Changes:
- Renamed documentation directories to remove numeric prefixes
- Updated navigation metadata in meta.json files for both English and Chinese documentation
- Updated all internal Markdown links throughout the documentation to reflect the new URL structure
Reviewed changes
Copilot reviewed 81 out of 107 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| content/docs/meta.json | Updated navigation config to reference non-numbered directory names |
| content/docs/cn/meta.json | Updated Chinese navigation config to reference non-numbered directory names |
| content/docs/framework/index.mdx | New index file created for framework section with updated internal links |
| content/docs/cn/framework/index.mdx | New Chinese index file created for framework section with updated internal links |
| content/docs/00-framework/index.mdx | Removed old numbered framework index file |
| content/docs/cn/00-framework/index.mdx | Removed old numbered Chinese framework index file |
| All other .mdx files | Updated internal documentation links to remove numeric prefixes from URLs |
|
@copilot 检查确认所有文档中的链接 |
已完成所有文档链接的验证 ✅ 验证结果:
**所有链接目标文件均已验证存在,没有失效链接。**构建测试也已通过,文档站点可以正常访问所有页面。 |
|
@copilot 所有的英文文档也要改 |
已检查所有英文文档,确认: ✅ 所有英文文档目录已重命名(framework, objectql, objectui, objectos) 英文文档和中文文档的更新已完成。如果您指的是其他需要修改的地方,请具体说明。 |
Documentation URLs contained numeric prefixes (
00-framework,02-objectql,03-objectui,04-objectos) that served no semantic purpose and reduced URL clarity.Changes
Directory structure: Renamed 8 directories to remove numeric prefixes
00-framework→framework,02-objectql→objectql, etc.cn/subdirectoryNavigation metadata: Updated
meta.jsonfiles to reference new directory namesInternal links: Updated 300+ MDX file links from numbered paths to clean paths
/docs/02-objectql/protocol-spec→/docs/objectql/protocol-spec/docs/03-objectui/core-concepts→/docs/objectui/core-conceptsResult
URLs are now cleaner and more maintainable:
Build verified with no broken links.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.