NotionNext 使用说明文档维护策略
维护位置(权威来源)
自 2026 年起,NotionNext 面向部署者的使用说明 以本仓库 docs/user-guide/ 目录为主维护面,并逐步替代仅依赖 Notion 托管的在线手册(docs.tangly1024.com)。
| 目录 | 用途 |
|---|---|
docs/user-guide/ | 部署、配置、Notion 数据库、菜单、升级等用户教程(从官方站点迁移并持续更新) |
docs/user-guide/reference/ | 4.9.x 参考手册:全站配置索引、Notion 新能力(与 conf/ 同步维护) |
docs/user-guide/themes/THEMES_CATALOG.md | 25 个内置主题全表与选型 |
docs/developer/themes/(GitHub) | 开发者向长篇(Claude 全局改动等);站长向在 user-guide/themes/<id>.md |
docs/developer/(GitHub) | 架构、贡献流程、主题开发者长文(不进在线站) |
为何迁到 GitHub
- 版本与代码同步:文档与
main分支、发行版号(如 4.9.5.x)同仓管理,避免「站点文档滞后于代码」。 - PR 可审阅:教程修正与功能改动可同一 PR 讨论。
- 可构建静态站:Markdown 可经 VitePress / Nextra 等生成可浏览网站(规划见
user-guide/WEBSITE.md)。 - 离线可读:克隆仓库即可阅读,不依赖 Notion API 拉取文档库。
与线上一致性
- 已迁移文章文末保留 「原文链接」,指向 docs.tangly1024.com 对应页面,便于对照与补图。
- 官方 Notion 文档库在过渡期仍可能更新;以本仓库
docs/user-guide/最新提交为准 作为 notionnext-org 主线推荐说明(fork 可自行同步)。
贡献者如何改文档
操作步骤、目录秩序、检查清单见 用户文档维护工作流(维护者必读)。
简要规则:
- 用户向教程 → 编辑
docs/user-guide/**/*.md,并同步user-guide目录索引、ARTICLE_INDEX.md。 - 主题说明 →
docs/user-guide/themes/<id>.md;仅开发细节写docs/developer/themes/。 - 勿将个人
.env、私有 ID 写入示例。 - PR 描述中注明:是否替代/补充线上某篇文档(附 slug 或 URL)。
迁移进度
官方帮助手册核心栏目已迁入 user-guide/,对照表见 user-guide/ARTICLE_INDEX.md。状态见 user-guide/MIGRATION_STATUS.md。
English summary
End-user documentation is maintained in this repo under docs/user-guide/, as the long-term source of truth replacing Notion-only hosting at docs.tangly1024.com. Developer docs remain under docs/. Migrated pages link back to the legacy site during transition.