main
)代表用于构建线上文档的内容。除非你选择将其他分支合并到部署分支,否则它们都与线上文档相互独立。
分支允许你为文档创建独立实例,以便在发布前进行更改、获取评审并尝试新方案。你的团队可以在不同分支上同时更新文档的不同部分;在你发布这些更改之前,用户在你的线上站点上看到的内容不会受到影响。
我们建议在更新文档时始终通过分支进行工作,以保持线上站点稳定,并支持评审工作流。
- 清晰命名分支,便于队友理解你正在做什么。
- 合并后删除分支,保持代码库整洁。
- 如进行可能影响他人工作的重大变更,请提前告知团队。
创建分支
- 在编辑器工具栏中选择分支名称(通常默认为
main
)。 - 选择 New Branch。
- 为分支输入一个描述性名称,例如
update-getting-started
或fix-api-examples
。 - 选择 Create Branch。
在分支上保存更改
切换分支
- 在编辑器工具栏中选择当前分支名称。
- 在下拉菜单中选择要切换的分支。
切换分支时,未保存的更改将丢失。请在切换前先保存或发布你的内容。