Este repositório contém o código-fonte da documentação do criador em create.roblox.com/docs.
Nota : Atualmente, o repositório possui guias, tutoriais, conteúdo educacional e a referência da API do Engine. Amostras de código estarão disponíveis em breve.
Se você não estiver familiarizado com o processo de contribuição do GitHub, consulte Sobre solicitações pull e o vídeo a seguir.
Se você encontrar um problema com a documentação e não quiser enviar uma solicitação pull, informe-nos reportando-o nos fóruns de desenvolvedores Roblox.
Qualquer adição à documentação do criador do Roblox deve se enquadrar em um todo maior. Em outras palavras, mesmo uma postagem de blog ou documento técnico abrangente, preciso e bem escrito pode não ter um início no site.
De modo geral, procuramos conteúdo que esteja em conformidade com nossos padrões existentes e que se aplique a uma ampla variedade de experiências e casos de uso. Por exemplo, preferimos páginas como Construindo interfaces de usuário a páginas como Criando um velocímetro para um jogo de corrida . Considere postar guias mais especializados no fórum de desenvolvedores Roblox.
Ao enviar uma solicitação pull para revisão, você deve concordar com o seguinte:
Esta contribuição foi criada total ou parcialmente por mim e tenho o direito de enviá-la sob os termos das licenças de código aberto deste repositório.
Entendo e concordo que esta contribuição e seu registro são públicos, mantidos indefinidamente e podem ser redistribuídos sob os termos das licenças de código aberto deste repositório.
Até onde sei, todas as alterações propostas são precisas.
Para alterações simples que afetam apenas um único arquivo, use o editor baseado na web do GitHub:
Encontre o arquivo em content/en-us/ e clique em Edit this file .
Clique em Bifurcar este repositório .
Faça suas alterações e clique em Confirmar alterações... .
Dê à sua alteração uma mensagem de confirmação descritiva e clique em Propor alterações .
Certifique-se de que o repositório base seja Roblox/creator-docs e o branch base seja main . Verifique se você está satisfeito com suas alterações e clique em Criar solicitação pull .
Por fim, preencha os detalhes na descrição da solicitação pull e clique em Criar solicitação pull .
Para alterações maiores que envolvem vários arquivos, recomendamos github.dev, um editor de texto mais completo baseado no Visual Studio Code que é executado em seu navegador:
Bifurque o repositório.
Enquanto navega em seu fork, pressione o botão . chave para abrir github.dev.
No menu Controle de origem , clique em ... > Ramificação > Criar ramificação... .
Dê um nome à ramificação e clique em Alternar para ramificação .
Use o menu Explorer para encontrar os arquivos que deseja atualizar em content/en-us e faça as alterações desejadas.
No menu Controle de origem , verifique se você está satisfeito com suas alterações.
Adicione uma mensagem de commit e clique em Commit & Push .
Em uma nova guia do navegador, navegue até github.com/Roblox/creator-docs.
Clique em Comparar e solicitar solicitação .
Verifique se o repositório base é Roblox/creator-docs e o branch base é main . O repositório principal deve ser seu fork e seu branch.
Por fim, preencha os detalhes na descrição da solicitação pull e clique em Criar solicitação pull .
Como alternativa, você pode usar os menus GitHub ou GitHub Pull Request em github.dev para enviar a solicitação pull. Para obter documentação sobre como usar github.dev, consulte GitHub Codespaces.
Este repositório é extremamente grande, por isso recomendamos usar as opções online sempre que possível. No entanto, se você já estiver familiarizado com o fluxo de trabalho geral do GitHub e quiser usar um editor de texto offline, aqui estão as etapas básicas para contribuir com a documentação:
Configure o Git e o Git LFS. Alternativamente, instale um cliente Git como GitHub Desktop.
Bifurque este repositório.
Clone seu garfo.
Navegue até a raiz do repositório.
Crie uma nova filial.
Faça as alterações desejadas.
Confirme, envie para seu fork e envie sua solicitação pull para o branch main deste repositório.
Para etapas mais detalhadas, consulte CONTRIBUTING.md.
A documentação do Roblox possui três tipos principais de documentos:
Guias conceituais e baseados em tarefas em arquivos .md em content/en-us/
Os guias ensinam sobre um recurso ou fluxo de trabalho sem serem excessivamente prescritivos sobre o resultado final. Eles apresentam conceitos e recursos e abordam as tarefas que você pode realizar usando diversas ferramentas ou outras abordagens.
Os guias se beneficiam enormemente de casos de uso práticos e reais, imagens, trechos de código e diagramas. A maior parte do conteúdo baseado em tarefas deve incluir uma lista numerada.
Documentos de referência de API em arquivos .yaml em content/en-us/reference
APIs são inteiramente conteúdo de referência e devem usar descrições funcionais, com links para guias quando apropriado. Mais do que outros tipos de conteúdo, o conteúdo de referência deve ser conciso e direto; resumos de propriedades, métodos, eventos e retornos de chamada não precisam ser frases completas.
Tutoriais em arquivos .md em content/en-us/tutorials
Em comparação com os guias baseados em tarefas, os tutoriais são mais independentes e levam você do nada para alguma coisa . Esse foco na criação de algo específico significa que eles são normalmente muito mais prescritivos do que guias. Os tutoriais geralmente abordam vários recursos e conceitos ao mesmo tempo, demonstrando as conexões entre ferramentas e estratégias.
Se a sua contribuição não se enquadrar nestas categorias ou cobrir um assunto particularmente restrito, poderá não ser uma boa opção para a documentação. Considere publicá-lo no fórum de desenvolvedores Roblox.
Tente limitar suas edições a uma classe ou recurso para que a solicitação pull seja mais fácil de revisar. Correções de bugs e melhorias menores têm maior probabilidade de aprovação rápida. Guias grandes geralmente exigem idas e vindas significativas antes da publicação.
Para evitar problemas de formatação, recomendamos editores de texto como github.dev, que permitem visualizar o Markdown enquanto você o escreve. Para prosa, tente seguir as orientações em STYLE.md. Para exemplos de código, use o Lua Style Guide.
Para visualizar uma página totalmente formatada de acordo com o que vemos no branch main , substitua a URL inteira de content/ e before. Arquivos com index de nome base devem ter esse nome removido. Por exemplo, a página para "https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md" é renderizada em "https://create.roblox.com /docs/pt-br/avatar".
Para prosa, este projeto usa a Licença Pública Internacional Creative Commons Attribution 4.0. Para obter o texto completo da licença, consulte LICENÇA.
Amostras de código estão disponíveis sob a licença MIT. Para obter o texto completo da licença, consulte CÓDIGO DE LICENÇA.
Para manter uma comunidade aberta, acolhedora, diversificada, inclusiva e saudável, este projeto impõe uma versão adaptada do Pacto do Contribuidor. Para obter mais informações, consulte CODE_OF_CONDUCT.md.
