IntersectMBO / IntersectMBO/developer-experience

Add Default Cardano developer environment how-to guide

Open
#264 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement High Priority stale
Dominant language
TypeScript
Stars
13
Forks
22
Avg merge
18h 40m
Merged PRs (30d)
11

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:

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)

Contributor guide

Open the contributing guide

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.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.