-
-
Notifications
You must be signed in to change notification settings - Fork 108
Description
在提交pr之前需要本地运行build检查
本地运行:
npm run docs:build
这样可以检查编译是否正确,排除一些链接错误的问题
保留官网链接地址
- 所有官网文档内的链接,都保留原有链接地址
- 即使链接到内部其它文档,也保留原链接地址
- 即使链接的文档已经翻译过,也保留官网的链接地址,在所有文档翻译完成后统一修改为内部链接
文档名称和官网文档名称一致
-
不带目录的文件名例如:
Token Program 官网地址为 https://spl.solana.com/token 带有文件名
token, 本地文件名为token.md -
带有目录的文件名例如:
Proposed Inflation Schedule 官网地址为 https://solana.com/zh/docs/economics/inflation/inflation-schedule 带有目录
economics/inflation和文件名inflation-schedule,本地文件名为economics/inflation/inflation-schedule.md -
不带有目录和文件名例如:
staking 官网地址为 https://solana.com/docs/economics/staking/ 只有目录没有文件名,本地文件名需要命名为和目录同名
staking.md,不能命名为index,因为index文件会出现下一页显示不正常现象
井号#️⃣级别问题
有些官网的井号级别并不是按照从小到大的顺序进行的,例如Backward Compatibility Policy在这个页面的源代码中可以看到井号是从###开始的,我们如果这样做,会导致页面在渲染后显示右边栏导航错误,所以我们要修改井号的级别
- 标题#️⃣一个井号开始
- 二级标题三级标题按顺序从小到大设置
专有名词翻译规范
- Cluster - 集群
- Devnet - 开发网
- Testnet - 测试网
- Mainnet-beta - 主网beta版
引用翻译方法
-
对应蓝色(INFO)、黄色(CAUTION)、红色(WARNING)的引用框使用下面的方法翻译,在文档渲染后可以保持原样
::: tip INFO
This is a INFO.
:::::: warning CAUTION
This is a CAUTION.
:::::: danger WARNING
This is a WARNING.
:::
图片问题
- 所有图片引用官网图片地址链接