Skip to content

Reorganize docs/features categories#49

Open
kafei-cy wants to merge 1 commit intoTongsuo-Project:mainfrom
kafei-cy:main
Open

Reorganize docs/features categories#49
kafei-cy wants to merge 1 commit intoTongsuo-Project:mainfrom
kafei-cy:main

Conversation

@kafei-cy
Copy link
Copy Markdown

Reorganize docs/features categories

背景

为了提升 docs/features 目录下功能文档的可读性、可维护性和侧边栏导航体验,本次对相关文档进行了统一整理与重分类。

本次调整的重点是:

  • 重建更清晰的分类结构
  • 优化文档在侧边栏中的展示顺序
  • 确保图片、相对链接和页面访问正常
  • 尽量保持原有页面访问路径兼容

修改概览

本次 PR 主要对 docs/features 目录进行结构性整理,包含以下内容:

  • 将原本分散在 docs/features 下的文档,按主题重新归类到新的子目录中
  • 目录名统一使用英文,便于仓库维护
  • 侧边栏分类名称使用中文,提升页面展示的可读性
  • 为各分类补充或调整 _category_.json,明确分组和顺序
  • 为部分移动后的文档补充 slug,尽量保持原有访问路径稳定(为了避免收藏该页面的人用原来的网址索引不到对应文字)
  • 按目录层级变化修正图片和本地相对链接路径,避免资源失效

重组后的分类

整理后,docs/features 主要划分为以下分类:

  • getting-started:综合使用教程
  • algorithm-practice:算法实战
  • protocols-and-certs:协议与证书
  • post-quantum:后量子密码
  • performance-optimization:国密性能优化
  • whitebox-sm4:SM4 白盒
  • ecosystem-integrations:生态集成
  • products-and-compliance:产品与合规
  • platforms:平台适配与系统安装

调整原则

本次整理遵循以下原则:

  • 不修改文档正文的实际内容
  • 仅调整目录结构、分类配置及必要的 front matter
  • 在目录迁移后同步修正资源引用,确保图片和相对链接继续可用
  • 对有必要保持访问兼容性的页面补充 slug

具体变更内容

1. 分类结构重建

将原本位于 docs/features 根目录或旧分类中的文档,按内容主题重新组织到新的分类目录下,使导航层次更加清晰,便于用户按场景查阅。

2. 侧边栏展示优化

通过新增或调整 _category_.json

  • 为每个分类设置中文展示名称
  • 优化同类文档的排列顺序
  • 使文档分组与阅读路径更符合实际使用场景

3. 路径兼容性处理

由于文档发生目录迁移,本次同步处理了以下兼容性问题:

  • 修正图片资源的相对引用路径
  • 修正文档内部本地跳转和相对链接
  • 为部分页面增加 slug,尽量保持原有 URL 稳定

验证情况

已对本次整理进行了基本校验,重点包括:

  • 图片资源引用保持可用
  • 本地相对链接未因目录调整而失效
  • 分类及顺序能够正确反映到文档结构中
  • 本地构建可通过,页面可正常生成

备注

已在本地构建并验证

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 17, 2026

Deploy Preview for tongsuo ready!

Name Link
🔨 Latest commit 75d7ef0
🔍 Latest deploy log https://app.netlify.com/projects/tongsuo/deploys/69e1d2131d105b0008045723
😎 Deploy Preview https://deploy-preview-49--tongsuo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

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.

1 participant