📄Documentação

Ajude a expandir a documentação do GaiaNet, facilitando a iniciação de novos programadores. Veja aqui como pode começar!

Contribuição

1. Bifurca o repositório:

   • Visite o Repositório de documentos GaiaNet no GitHub

   • Clique no botão "Fork" no canto superior direito

   • Selecione onde pretende bifurcar o repositório (a sua conta pessoal ou uma organização)

2. Clone o seu repositório bifurcado:

   git clone https://github.com/YOUR-USERNAME/docs.git
   cd docs

3. Crie um novo ramo para as suas alterações:

   git checkout -b o seu ramo de recursos

4. Efectue as suas alterações à documentação

5. Confirmar as alterações:

   git add . 
   git commit -m "Descrição das suas alterações"

6. Envie as suas alterações para o seu fork:

   git push origin o seu ramo de recursos

7. Criar um pull request:

   • Ir para a sua bifurcação no GitHub

   • Clique em "Pull request" e selecione "New pull request"

   • Selecione o ramo da sua funcionalidade e submeta o pull request Certifique-se de que as suas contribuições estão em conformidade com o nosso estilo e normas de documentação.

Executar a documentação localmente

Depois de bifurcar e clonar o repositório:

1. Instalar dependências:

   npm install

2. Iniciar o servidor de desenvolvimento:

   npm start

3. Abra o seu browser e visite http://localhost:3000

Estrutura

• docs/: Contém todos os ficheiros markdown para a documentação

• src/: Componentes e páginas React personalizados

• estático/: Activos estáticos como imagens

• docusaurus.config.js: Ficheiro de configuração principal do Docusaurus

Implantação

Esta documentação é automaticamente implantada em docs.gaianet.ai quando as alterações são integradas no ramo principal.

Precisa de ajuda?

Se tiver dúvidas ou precisar de ajuda, abra um problema no repositório ou contacte-nos através dos canais da nossa comunidade.