Skip to content
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

docs: adjust docs framework #6598

Merged
merged 13 commits into from
Feb 13, 2025
Merged

docs: adjust docs framework #6598

merged 13 commits into from
Feb 13, 2025

Conversation

interstellarmt
Copy link
Contributor

@interstellarmt interstellarmt commented Jan 24, 2025

新版官网文档结构
image

  • 文档结构调整
    • 隐藏选项菜单,原选项菜单的文档迁移到文档。
    • 文档菜单新增二级菜单「快速上手」、「图表组件」、「v4 升级 v5 指南」。
    • 文档-核心概念-图表菜单新增「图表组成」。
    • 文档-新增「选项一览」,展示所有选项,后续待补充。
    • 部分文档路由调整(见下图)
    • 同类文档合并。
      • 对于同一图表概念,将文档部分和选项部分进行合并。
      • 将「核心概念」-「规范(Spec)」合并到「简介」-「Spec 和 API」。
      • 将「核心概念」 - 「大小(Size)」、「视图(View)」合并到「图表「Chart」」。
    • 新增总览页面(hold 等待主题包功能实现)。
    • 对结构调整后的文档重新排序。
  • 结构调整后,排查所有文档,修改链接。
    • 「文档」链接修改。
    • 「API」链接修改。

image
image

-----------------------------------2月12日分界线------------------------------------------------------
done

  • 图表组成marker标识,组件新增label(图表布局调整合并到图表组成)
    image
  • 「色板」层级上移,内容补充「自定义注册和使用」,「颜色映射」颜色相关文档重新组织,目前太分散了
    • 新增「颜色映射(Color)」,放在核心概念下,将「色板」内容合并到「颜色映射」下的Palette部分,并新增自定义色板的案例。
    • 新增自定义色板的案例。
      image
  • 「数据标签」挪到「组件」,配置项打平在一个文件中管理
  • 「布局」内容放在对应用到的图中,不单独维护
  • 「事件」挪到「核心概念」
  • 「自定义」拆分到对应的位置
    • 自定义形状、自定义提示、自定义图例、自定义拖动轴移动到相应文档
    • 自定义符号移动到图例legend下,并补充用图片自定义图例图标的例子
      image
  • 「绘制 3D 图表」挪到 「3D 图表」下
  • 「版本特性」挪到一级,子项分别为「新版特性」、「Changlog」(暂无)、「v4 升级到 v5」
  • 「选项一览」先隐藏
    todo
  • 「事件」文档内容补充
  • 组件文档代码演示可交互
  • 「SSR」内容修改,改成新版实现方式

@interstellarmt interstellarmt changed the title [WIP]docs: adjust docs framework docs: adjust docs framework Feb 11, 2025
@interstellarmt interstellarmt merged commit 7f2b04a into v5 Feb 13, 2025
2 checks passed
@interstellarmt interstellarmt deleted the docs-refactor branch February 13, 2025 15:11
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