Add Default Cardano developer environment how-to guide

Aberta
  • Algo errado?
#264 1 comentário 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
68/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Domínio
documentation

Direção de pesquisa

Comece revisando o conteúdo existente em website/docs/how-to-guide/, a página Getting Started, o README para iniciantes e as notas relacionadas da Session 17. Elabore o guia do ambiente padrão voltado para novos contribuidores, vincule-o a partir dos pontos de entrada solicitados e execute npm run build. Está concluído quando a página estiver publicada, os links estiverem presentes, as etapas cobrirem as verificações de sucesso indicadas e o caminho de progressão, e o build for concluído com sucesso.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

documentation enhancement High Priority stale

Problem

Newcomers still lack a durable, opinionated default local developer environment guide on the DevEx site. Working Group Session 17 discussed local vs public testnets and tools like Yaci DevKit, but that content mostly lives in session notes rather than a first-class how-to.

The Intermediate how-to section was empty and removed (#191), which widens this gap between Beginner and Advanced.

Proposed solution

Publish a practical how-to under website/docs/how-to-guide/ that covers:

  1. Recommended default path for new builders (local-first where possible)
  2. Setup steps (e.g. Yaci DevKit / local devnet + indexer options)
  3. First success checks (query tip, faucet/test ADA, simple submit path)
  4. Graduation path to preview/preprod/mainnet
  5. Links out to Developer Portal / Mesh / Blockfrost as needed

Link the guide from Getting Started and Beginner README.

Acceptance criteria

  • New how-to page published (not only WG session notes)
  • Linked from Getting Started (and beginner index where appropriate)
  • Written for newcomers (clear steps, minimal jargon)
  • npm run build succeeds

Related

  • Session 17 notes (Default Developer Environment)
  • #115 (missing onboarding content)
  • #201 (pathway gaps; this is a smaller concrete slice)
Linguagem predominante
TypeScript
Estrelas
13
Forks
24
Merge médio
1d 8h
PRs com merge (30d)
16

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de IntersectMBO/developer-experience

Todas as issues de IntersectMBO/developer-experience

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.