Skip to content

[feat / enhaucement, help wanted] 我们需要帮助——添加一些mermiad图示! #54

Description

@Charliechen114514

背景

感谢各位朋友持之以恒的关心本项目!接到反馈,文章写的还OK,但是缺少大量可视化的图,包括但是不限于任何架构图,流程图,或者是一些实际运行的效果图。

笔者工作比较繁忙,已经有一些吃不消了,就目前整个仓库的图例情况而言,vol1, vol2已经完成的内容是重灾区。很多概念密度高、却全文无图的文章(所有权关系、内存序 happens-before、线程时序、类层次),恰恰是最该可视化、也最难靠文字建立直觉的部分。

主线目标

为「高概念密度却全文无图」的文章补充 mermaid 图,把难凭文字想象的概念变成一图秒懂。本 Issue 作为追踪 Issue,子任务以独立子 Issue(good first issue)挂在下方,持续滚动更新!之后类似图示概念的Help Wanted Issue,就挂在这个Issue下,防止Issue一大堆,看着乱七八糟的!

如果您想帮忙,您如何行动呢?

  1. 在目标章节插入 mermaid 代码块,图型与内容如挂靠在下的子 Issue 所述;
  2. pnpm dev 本地预览,确认图正确渲染(如果实在不太方便,可以大胆先提PR,At我来进行验证)
  3. 图中事实与正文一致,不改动任何代码块与技术断言(纯增量);
    (英文部分,您可以看情况,笔者会周期性的维护英文翻译版本!)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestfeaturefeature, which enhaucement is using in improvement no matter it is bug fix or anythong else :)
    No fields configured for Feature.

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions