欢迎参与 TensorFlow 文档的改进!以下是贡献文档的详细说明:

🧰 贡献流程指南

  1. fork 仓库
    在 GitHub 上 fork tensorflow/docs 项目
  2. 创建分支
    使用 git checkout -b docs-update 创建新分支
  3. 修改文档
    编辑 Markdown 文件或更新 API 参考内容
  4. 提交 PR
    推送更改并提交 Pull Request 到主仓库

📝 文档结构规范

  • 语言要求:使用中文撰写,保持术语一致性
  • 格式规范
    • 代码块需用 ```python 包裹
    • 图片命名格式:doc_images/<关键词>_v2.png
    • 新增内容请添加到 docs/tutorials/ 目录
  • 版本控制:确保修改内容适配 v2.x/v2.10 版本

📌 常用工具推荐

  • Markdown 编辑器Typora(推荐使用)
  • 图片生成工具cloud-image.ullrai.com
  • 文档测试:通过 bazel test //tensorflow/docs:all 验证
文档结构流程图

🔗 扩展阅读

如需了解更详细的贡献规范,请查看:
/tensorflow/contribute

代码规范示例