文档风格指南
我们还没有正式的风格指南，但当前的 OpenTelemetry 文档风格受到以下风格指南的启发：
以下部分包含特定于 OpenTelemetry 项目的指南。
我们的风格指南的许多要求都可以通过运行自动化来强制执行：在提交 pull request (PR) 之前，在本地机器上运行 npm run fix:all 并提交更改。
如果遇到错误或 PR 检查失败，请阅读我们的风格指南，了解如何解决某些常见问题。
OpenTelemetry.io 词汇表
一份在网站上需要一致使用的 OpenTelemetry 特定术语和单词列表
有关 OpenTelemetry 术语及其定义的完整列表，请参阅 术语表。
请确保专有名词，例如其他 CNCF 项目或第三方工具，都得到正确书写并使用原始的大小写。例如，应写“PostgreSQL”而不是“postgre”。如需完整列表，请查看 .textlintrc.yml 文件。
Markdown
网站页面使用 Goldmark Markdown 渲染器支持的 Markdown 语法编写。有关支持的 Markdown 扩展的完整列表，请参阅 Goldmark。
您也可以使用以下扩展：
- GitHub-flavored Markdown (GFM) 警示框
- 表情符号。有关可用表情符号的完整列表，请参阅 Hugo 文档中的 表情符号。
Markdown 检查
为了强制执行 Markdown 文件的标准和一致性，所有文件都应遵循特定的规则，这些规则由 markdownlint 执行。如需完整列表，请查看 .markdownlint.yaml 和 .markdownlint-cli2.yaml 文件。
我们还强制执行 Markdown 文件格式 并清除文件末尾的空格。这将排除 2 个或更多空格的 换行语法；请改用 <br> 或重新格式化文本。
拼写检查
使用 CSpell 来确保您的所有文本都拼写正确。有关 OpenTelemetry 网站特有的单词列表，请参阅 .cspell.yml 文件。
如果 cspell 显示“未知单词”错误，请检查您是否正确拼写了该单词。如果是，请将该单词添加到文件顶部的 cSpell:ignore 部分。如果不存在该部分，您可以将其添加到 Markdown 文件的 front matter 中：
---
title: PageTitle
cSpell:ignore: <word>
---
对于任何其他文件，请在适合文件上下文的注释行中添加 cSpell:ignore <word>。对于 注册表条目 YAML 文件，可能如下所示：
# cSpell:ignore <word>
title: registryEntryTitle
文件格式
我们使用 Prettier 来强制执行文件格式。使用以下命令调用它：
npm run fix:format格式化所有文件npm run fix:format:diff仅格式化自上次提交以来已更改的文件npm run fix:format:staged仅格式化已暂存以便下次提交的文件
文件名
所有文件名都应采用 kebab case（短横线分隔命名法）。
修复验证问题
要了解如何修复验证问题，请参阅 Pull request checks。