starknet docs

Repositório de documentação de Starknet

O site da Starknet Docs, https://docs.starknet.io, está escrito no ASCIIDOC e é construído usando o Antora, um gerador de sites estáticos da ASCIIDOC.

Contribuindo para a documentação de Starknet

Se você estiver interessado em contribuir para a documentação técnica do StarkNet, a tabela a seguir fornece links rápidos para ajudá -lo a começar.

Pergunta	Recurso
Estou interessado, como faço para contribuir?	Para obter informações sobre como você pode contribuir, consulte diferentes maneiras de contribuir.
Existem diretrizes básicas para me ajudar?	Para diretrizes básicas para nos ajudar a manter nosso conteúdo consistente, consulte as diretrizes de documentação.
Existe um guia de estilo e um guia de redação que eu deveria usar?	Consulte o Guia de estilo suplementar de documentação Starknet.
Como faço para configurar minha estação de trabalho?	Consulte Configurando seu ambiente.

Maneiras diferentes de contribuir

Existem algumas maneiras diferentes de contribuir para a documentação de Starknet:

• Crie um problema do GitHub.

• Envie uma solicitação de tração (PR). Você pode criar um clone local do seu próprio garfo do repositório StarkNet-Docs, fazer suas alterações e enviar um PR. Esta opção é melhor se você tiver alterações substanciais ou para ajudar as alterações que deseja ser adicionado mais rapidamente.

O que acontece quando você envia um PR?

Quando você envia um PR, a equipe da Starknet Docs analisa o PR e organiza outras revisões técnicas, conforme necessário. Se o PR exigir alterações, os revisores adicionam comentários ao PR. Podemos solicitar que você faça as alterações ou que você saiba que incorporamos seu conteúdo em um PR diferente. Ocasionalmente, podemos adicionar compromissos diretamente ao PR original. Quando o PR foi revisado e todas as atualizações estão concluídas, a equipe de documentação mescla o PR e a aplica às versão válida (s).

Dicas sobre a autoria

• Starknet Documentation Suplementary Style Guide: Orientação de estilo geral e orientação de redação.

Para obter informações sobre a redação no ASCIIDOC, consulte:

• Documentação do idioma ASCIIDOC

• Referência rápida de sintaxe asciidoc

Observação

Existem várias maneiras de codificar IDs, blocos de código-fonte, referências cruzadas e links. Em geral, usamos as convenções de codificação mais explícitas para codificação para priorizar a legibilidade do código. A maioria dessas convenções de codificação está listada em referência rápida de marcação ASCIIDOC para a documentação do Red Hat

Antes de começar

1. Instale yarn se ainda não estiver instalado.

2. Instale npx se ainda não estiver instalado.

3. Clone este repositório, de um garfo, ou se você é um colaborador oficial, diretamente do starknet-io/starknet-docs .

4. Altere para o diretório starknet-docs .

5. Execute o comando yarn para preparar o ambiente:

    fio

yarn devem preparar seu ambiente instalando os módulos necessários com base no package-lock.json e package.json . Se tiver sido bem -sucedido, você poderá construir e visualizar o conteúdo.

Construindo e visualizando o conteúdo localmente

Depois de escrever ou editar conteúdo, para visualizar suas alterações:

1. Construa o conteúdo executando o script build_local_site.sh .

   ./build_local_site.sh

   Este comando gera o site no diretório public_html .

2. Abra o site fazendo um dos seguintes:

   • Abra a página inicial: <repo_root>/public_html/index.html .

   • Execute o servidor HTTP embalado com a antora:

     npx http-server public_html -c-1

     O servidor é executado e fornece um ou mais URLs locais que você pode usar para visualizar o site. Por exemplo:

     Starting up http-server, serving public_html
     
     ...
     
     Available on:
       http://127.0.0.1:8080
       http://192.168.68.111:8080
       http://192.168.14.3:8080
       http://10.14.0.2:8080
     Hit CTRL-C to stop the server

Liberando Starknet Docs no Github (somente para administradores)

O processo de alto nível para liberar mudanças de documentação neste repositório.

Durante o curso do desenvolvimento de conteúdo, os escritores mesclam ramificações com alterações diretamente em main , em uma filial secundária, conforme necessário, onde essas mudanças esperam até que estejamos prontos para liberá -los - ou seja, publique -os no docs.starknet.io.

As ações do GitHub criam tags e lançamentos git que aparecem nas páginas de lançamentos e tags do repositório.

Quando uma filial de recursos é mesclada no ramo main , uma ação do GitHub cria uma tag de liberação no formato v<version>.<major_update>.<minor_update> e atualiza CHANGELOG.md . Em seguida, publica o novo conteúdo para docs.starknet.io.

Procedimento

A mesclagem de uma filial de recursos para main publica automaticamente alterações na filial do recurso. Não são necessárias etapas adicionais.

O GitHub incrementa os números de versão em package.json e package-lock.json e atualiza CHANGELOG.md com as descrições de cada PR que acabou de ser fundido no main . . Atualize sua filial main local da filial main remota usando um dos seguintes:

• Puxe as mudanças:

  starknet-docs (main) git pull

• Faça uma rebase de [email protected]:starknet-io/starknet-docs.git :

  starknet-docs (main) git fetch origin
  starknet-docs (main) git rebase origin/main

  Observação

  Se você estiver usando um garfo, seu repo bifurcado será origin por padrão; nesse caso, você deve atribuir o nome upstream a [email protected]:starknet-io/starknet-docs.git . Portanto, ao se rebasar, use upstream em vez de origin nos comandos acima.