docs(developer-guide): 新增开发指南分类(架构/需求/详细设计/数据模型/贡献指南) - #6
Merged
Conversation
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.
概述
新增 开发指南(developer-guide) 分类,把分散在 Ikaros 主仓库(ikaros-dev/ikaros)里的各类文档提炼汇总到文档站,便于开发者一站式查阅。整体结构参考现有 user-guide 分类的组织方式(目录 + 按主题分篇 + sidebars 注册)。
新增文档(docs/developer-guide/)
docs/Product-Requirements-Document.mddocs/High-Level-Design.mddocs/Low-Level-Design.mddocs/data-structure/(5 篇汇总)CONTRIBUTING.md路由配置
按 Docusaurus 约定:内容文件放
docs/developer-guide/,在sidebars.js的docsSidebar中注册分类(generated-index自动生成索引页,位于 user-guide 与 plugins 之间),无需其他路由改动。验证
npm run build通过:zh / en 两个 locale 均构建成功,无 broken link(修正了版本化站点内相对链接改为绝对路径)。纯文档变更。