iota wiki

Explore o wiki

Erro de relatório · Tópico de solicitação

Índice

• Sobre o projeto
  • Construído com
• Começando
  • Pré -requisitos
  • Desenvolvimento local
• Contribuindo
• Contato

Sobre o projeto

O IOTA Wiki é um hub central para entrar no ecossistema IOTA. Uma iniciativa orientada à comunidade para fornecer uma coleção atualizada de apresentações e leituras adicionais sobre a tecnologia, as equipes, a comunidade e tudo mais. Para que qualquer pessoa possa aprender a construir, adotar e se envolver com a IOTA, tudo em um espaço.

Construído com

O IOTA Wiki é construído usando o TypeScript, Reactjs e Docusaurus v2.0.

Começando

Pré -requisitos

• Git 1.8.2 ou acima.
• Node.js 16.10 ou acima.
• O fio moderno ativado executando corepack enable .

Visualizar localmente

Para visualizar o wiki localmente, use as etapas a seguir. Para scripts mais detalhados, consulte scripts pré-configurados para referência.

Observe que o wiki tem muito conteúdo, então atualmente a compilação inicial está demorando um pouco. É feito um esforço para tentar reduzir o tempo de construção no futuro.

1. Clone o repositório executando git clone https://github.com/iotaledger/iota-wiki.git e vá ao diretório com cd iota-wiki .
2. Instale dependências com yarn .
3. Prepare o ambiente executando yarn prepare , isso deve ser feito apenas uma vez.
4. Visualize o wiki com yarn start , isso iniciará um servidor de desenvolvimento que serve o wiki com capacidade de recarga a quente, para que atualize o conteúdo após a que qualquer alteração foi feita.

Scripts pré-configurados

Script	Explicação
prepare	Prepare o meio ambiente verificando a construção dos submódulos.
start	Inicie um servidor de desenvolvimento que serve o wiki, com recarregamento a quente nas alterações.
start:section:{section}	Inicie um servidor de desenvolvimento que serve apenas uma seção do wiki, com recarregamento a quente nas alterações. As seções disponíveis são build , get-started , learn e maintain .
build	Construa o wiki. Para construir para a produção, consulte a versão mais recente da documentação externa executando yarn checkout:remote e defina a variável de ambiente MODE para production .
checkout:remote	Confira a versão mais recente da documentação externa.
generate:api	Gere a documentação da API disponível configurada através do plug -in Docusaurus OpenAPI e compilando a documentação do código -fonte.

Contribuindo

O IOTA Wiki é mantido pelas contribuições IF e da comunidade são sempre bem -vindas. A equipe do DX e as equipes relacionadas do IF revisarão todos os problemas e puxarão solicitações publicadas neste repositório. Se você notar algum erro ou sentir que algo está faltando, fique à vontade para criar um problema para discutir com a equipe ou criar diretamente uma solicitação de tração com sugestões. Aqui está um fluxo de trabalho básico para abrir uma solicitação de tração:

1. Bire esse repositório para sua própria conta e clone-a ( git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git )
2. Crie uma filial de recursos para suas alterações ( git checkout -b feat/amazing-feature ).
3. Faça suas alterações e, opcionalmente, visualize -as localmente.
4. Execute yarn format e yarn lint e corrija os erros e avisos restantes.
5. Compreenda suas alterações ( git commit -m 'Add some amazing feature' ).
6. Empurre suas alterações no garfo ( git push origin feat/amazing-feature ).
7. Abra uma solicitação de tração para o ramo main deste repositório.

Dê uma olhada em contribuir para mais orientações.

Versão

Para descobrir como fazer uma versão dos seus documentos, leia este guia.

Configuração on-line de um clique para contribuir

Você pode usar o GITPOD (um IDE gratuito, online e semelhante ao código) para contribuir. Com um único clique, ele preparará tudo o que você precisa para construir e contribuir para o wiki. Basta clicar neste botão e pule a etapa 1 de cima.

Contato

Phylo - Phyloiota - Phylo [Comunidade Dao - Lets Go!]#2233
Jeroen van den Hout - Jlvandenhout - JVDHOUT#4402
Dr.Electron - DR -Electron - Dr.Electron#9370
Crítico - Kilianhln - Crítico#7111
JSTO - JSTO91 - JSTO#3746