Skip to content

docs(developer-guide): 新增开发指南分类(架构/需求/详细设计/数据模型/贡献指南) - #6

Merged
chivehao merged 1 commit into
ikaros-dev:mainfrom
nekoili:feature/developer-guide
Aug 22, 2026
Merged

docs(developer-guide): 新增开发指南分类(架构/需求/详细设计/数据模型/贡献指南)#6
chivehao merged 1 commit into
ikaros-dev:mainfrom
nekoili:feature/developer-guide

Conversation

@nekoili

@nekoili nekoili commented Aug 22, 2026

Copy link
Copy Markdown
Contributor

概述

新增 开发指南(developer-guide) 分类,把分散在 Ikaros 主仓库(ikaros-dev/ikaros)里的各类文档提炼汇总到文档站,便于开发者一站式查阅。整体结构参考现有 user-guide 分类的组织方式(目录 + 按主题分篇 + sidebars 注册)。

新增文档(docs/developer-guide/)

文件 内容 来源
requirements.md 产品需求:目标用户、FR 编号体系、NFR、版本规划 ikaros docs/Product-Requirements-Document.md
architecture.md 系统架构:分层架构、Gradle 多模块、ADR 决策表 ikaros docs/High-Level-Design.md
detailed-design.md 模块详细设计:安全/条目/剧集/附件/收藏/绑定/搜索/插件/音乐/App/测试 ikaros docs/Low-Level-Design.md
data-model.md 数据模型:Subject/Episode/Attachment 统一模型 + ER 图 + 音乐/漫画/小说映射 ikaros docs/data-structure/(5 篇汇总)
contribution-guide.md 贡献指南:协作流程规范(issue/discussion/PR)+ 代码贡献步骤 + 提交规范 ikaros CONTRIBUTING.md

路由配置

按 Docusaurus 约定:内容文件放 docs/developer-guide/,在 sidebars.jsdocsSidebar 中注册分类(generated-index 自动生成索引页,位于 user-guide 与 plugins 之间),无需其他路由改动。

验证

npm run build 通过:zh / en 两个 locale 均构建成功,无 broken link(修正了版本化站点内相对链接改为绝对路径)。纯文档变更。

@chivehao
chivehao merged commit f905ed5 into ikaros-dev:main Aug 22, 2026
2 checks passed
@nekoili
nekoili deleted the feature/developer-guide branch August 22, 2026 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants