main
, representa o conteúdo usado para construir a documentação em produção. Todas as outras branches são independentes da sua documentação publicada, a menos que você decida mesclá-las na branch de implantação.
As branches permitem criar instâncias separadas da documentação para fazer alterações, receber revisões e testar novas abordagens antes de publicar. Sua equipe pode trabalhar em branches para atualizar diferentes partes da documentação simultaneamente, sem afetar o que os usuários veem no seu site em produção até que você publique as mudanças.
Recomendamos sempre trabalhar em branches ao atualizar a documentação para manter o site em produção estável e viabilizar fluxos de revisão.
- Nomeie as branches de forma clara para que os colegas entendam no que você está trabalhando.
- Exclua as branches após mesclar para manter o repositório organizado.
- Avise a equipe quando estiver trabalhando em alterações importantes que possam afetar o trabalho dela.
Criando uma branch
- Selecione o nome da branch na barra de ferramentas do editor (geralmente
main
por padrão). - Selecione New Branch.
- Insira um nome descritivo para sua branch, como
update-getting-started
oufix-api-examples
. - Selecione Create Branch.
Salvando alterações em uma branch
Alternando de branch
- Selecione o nome da branch na barra de ferramentas do editor.
- Escolha a branch para a qual deseja alternar no menu suspenso.
Alterações não salvas serão perdidas ao alternar de branch. Certifique-se de salvar ou publicar seu trabalho antes de alternar.