Skip to content

docs: fix Quick Start setup flow#226

Merged
BrianSeong99 merged 1 commit intomainfrom
brian/quick-start-fixes
Mar 21, 2026
Merged

docs: fix Quick Start setup flow#226
BrianSeong99 merged 1 commit intomainfrom
brian/quick-start-fixes

Conversation

@BrianSeong99
Copy link
Contributor

Summary

  • Fix "Deploy Your Account" section — miden client new-wallet already deploys automatically, no separate deploy step needed
  • Update Node.js version from hardcoded v20.11.0 to generic v22.x.x
  • Add "No artifact found" note for midenup install (expected when no pre-built binaries available)
  • Add troubleshooting for "config error: missing field" from old config files
  • Fix project creation section to reference project from installation step

Fixes #216

- Fix incorrect PATH instructions: midenup init creates miden symlink
  in $MIDENUP_HOME/bin, users need that directory in PATH
- Fix wrong env var ($XDG_DATA_DIR) and wrong which miden expected output
- Make Node.js version expectations generic (v22.x.x+)
- Fix "Deploy Your Account" section (was showing miden client new-wallet
  instead of explaining it already deploys automatically)
- Add note about "No artifact found" during midenup install being expected
- Fix project creation redundancy (reference project from installation)
- Add troubleshooting for old config file errors

Closes #216
@BrianSeong99 BrianSeong99 marked this pull request as ready for review March 21, 2026 09:25
@BrianSeong99 BrianSeong99 merged commit cde9e4c into main Mar 21, 2026
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: Fix Quick Start setup flow issues

1 participant