跳到主要内容

参与文档贡献

OXN 文档是活的资源——欢迎社区的修正、补充、澄清。

快速建议​

每页底部有 "Suggest an edit" 链接（指向源 .md 文件在 GitHub 上的位置）。小修——typo、坏链、错版本号——走这条最快。

本地开发​

本地开发文档：

git clone https://github.com/oxn-network/oxn-docs
cd oxn-docs
npm install
npm start                # dev server at http://localhost:3000
npm run build            # 生产构建
npm run serve            # serve 构建产物

构建同时支持英文和中文 locale。预览中文：

npm start -- --locale zh-CN

风格指南​

语气

  • 直接、主动语态。"Set gasLimit to 500,000" 比 "The gasLimit should be set to 500,000" 好。
  • 指令用第二人称。"You'll need Node.js 18+" 比 "One needs Node.js 18+" 好。
  • 假设读者懂以太坊但对 OXN 陌生。

代码示例

  • 尽可能完整可运行。片段化片段让读者头疼。
  • Solidity 例子里带 import 与 pragma。
  • 每个 OXN 交易例子都带 gasLimit。
  • 偏向 paris 编译器设置。

术语

  • OXN——链、品牌。
  • BLUAI / TBLUAI——钱包显示的原生代币符号。测试网上是 TBLUAI（无经济价值），主网上是 BLUAI。描述代币概念时用 BLUAI，描述具体测试网显示时用 TBLUAI。
  • 0x…——EVM 地址。oxn1…——原生地址。
  • 加密调用——带加密 CBOR 信封的交易。
  • 签名查询——填充 msg.sender 的经认证 eth_call。

与术语表保持一致。

格式

  • 参考数据用 Markdown 表格。
  • 重要提示用 :::info、:::warning、:::danger callout。
  • 代码块指定语言以启用高亮。
  • 左侧栏顺序由 frontmatter 的 sidebar_position 决定。

添加新页​

  1. 在 docs/ 下相应章节文件夹里建新 .md 文件。
  2. 加 frontmatter（title、sidebar_position、description）。
  3. 写内容。
  4. 在 i18n/zh-CN/docusaurus-plugin-content-docs/current/<section>/ 下建对应翻译文件。
  5. 本地 build 确认无坏链。
  6. 提 PR。

PR 评审流程​

评审看：

  • 技术准确性。
  • 与风格指南的一致性。
  • 两个 locale 都在（如果加新页）。
  • 本地 build 通过。
  • 与相关页的交叉链接。

贡献时寻求帮助​

非平凡贡献——新页、较大重组——先开 discussion issue 对齐范围。

下一步​