Add Default Cardano developer environment how-to guide
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
Start by reviewing the existing content under website/docs/how-to-guide/, the Getting Started page, the beginner README, and the related Session 17 notes. Draft the newcomer-focused default environment guide, link it from the requested entry points, and run npm run build. Done means the page is published, links are present, steps cover the stated success checks and graduation path, and the build succeeds.
Written by the indexing model from the issue text.
Description
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:
- Recommended default path for new builders (local-first where possible)
- Setup steps (e.g. Yaci DevKit / local devnet + indexer options)
- First success checks (query tip, faucet/test ADA, simple submit path)
- Graduation path to preview/preprod/mainnet
- 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 buildsucceeds
Related
- Session 17 notes (Default Developer Environment)
- #115 (missing onboarding content)
- #201 (pathway gaps; this is a smaller concrete slice)
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 22
- Avg merge
- 19h 1m
- Merged PRs (30d)
- 10
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from IntersectMBO/developer-experience
-
documentation good first issue
Difficulty 3/5 1-2 days Newbie friendliness 70/100
IntersectMBO/developer-experience#302 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 58/100
IntersectMBO/developer-experience#301 ·
Maintainers usually reply within 1 day
-
The component & design-token baseline for human and agentic developers (spacing, typography, theme, etc)Possibly taken @IanoNjuguna claimed this 18 days ago. Open
IntersectMBO/developer-experience#300 · 1 assignee ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
IntersectMBO/developer-experience#298 ·
Maintainers usually reply within 1 day
-
documentation enhancement good first issue Medium Priority stale
Difficulty 3/5 1-2 days Newbie friendliness 70/100
IntersectMBO/developer-experience#265 · 1 comment ·
Maintainers usually reply within 1 day
All issues in IntersectMBO/developer-experience
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
📕documentation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
db-ux-design-system/core-web#8343 ·
Maintainers usually reply within 1 day
-
enhancement triage/needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
heygen-com/hyperframes#4944 ·
Maintainers usually reply within 1 day
-
ai-driven-qa bug claude
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
linagora/twake-calendar-frontend#1493 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
material-extensions/vscode-material-icon-theme#3610 ·
Maintainers usually reply within 2 days