FOG 文档风格指南

FOG 的文档使用 Markdown 编写。您可以在 toolkit/components/glean/docs 中找到其源代码。

换行

我们将使用 语义换行符

• 在 80-100 个字符之前任何位置换行

• 在任何有意义的标点符号之后换行

• 在任何有意义的 Markdown 之前或之后换行

提示：为了保持行宽，请在有意义的情况下（或一直）使用 Markdown 的 引用链接 功能。

链接到其他文档

链接到其他外部文档非常 简单。链接到源代码文档中的其他文档需要链接到 sphinx 树中的源文件。

例如，链接到 [偏好设置] 文档可以使用相对链接

[preferences](preferences.md)

或者可以使用绝对链接，例如链接到 遥测 文档

[Telemetry](/toolkit/components/telemetry/index.rst)

Sphinx 会自动将该链接转换为带有 .html 后缀的、具有适当基本 URL 的 URL。

在进程中使用“主”与“父”

在讨论 Glean 时，区分我们是在主进程中还是在其他进程中操作非常有帮助。这是因为只有一个主进程，并且只有一个 Glean。但是，“父”是一个相对术语，它可能指的是一个进程，它是另一个进程的父进程，但它本身并不是主进程。在准确的情况下，优先使用“主”。