Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix (developer) docs: tool versions, troubleshooting, precisions, ... [](https://github.com/iotaledger/devx/issues/517) #4721

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

nmrshll
Copy link

@nmrshll nmrshll commented Jan 8, 2025

Description of change

An issue in devx describes small corrections to make to the page "Local development" of the docs.
This PR is for fixing those.

Links to any relevant issues

Fixes iotaledger/devx#517

Type of change

  • Documentation Fix

How the change has been tested

Describe the tests that you ran to verify your changes.

Make sure to provide instructions for the maintainer as well as any relevant configurations.

Change checklist

Tick the boxes that are relevant to your changes, and delete any items that are not.

  • I have followed the contribution guidelines for this project
  • I have made corresponding changes to the documentation

Status: needs review / documentation fixes

TODO: fix or answer these:

Here's some small issues I ran into when reading this page of the docs:

  1. "iota client envs" / "iota client switch" doesn't seem to work when current env is local AND local network is not running
    • Possible fix: make it possible to switch environment back to “testnet” without having to launch the local network again
    • should I open a separate issues about this ?
  1. In section “Install IOTA Wallet Locally” > “Build”:
    • “pnpm turbo build” fails:
      • SOLUTION: list some additional dependencies:
        • nodejs (minimum version to make it work seems to be nodejs_20 now)
        • Rust 1.82+ with target “wasm32-unknown-unknown”
        • docker-compose (+ docker daemon running) (or podman equivalent)
  • fix documentation
  1. In section “Install IOTA Wallet Locally”:
    • missing description of what the IOTA wallet is, what kind of app it is (desktop ? chrome extension only ? CLI ?)
    • what can I do with it once it builds successfully ? Why do I need to build it now ? are we using this in a later section of the docs ?
  • made some edits to the docs to try and explain this
  • [ ] review these changes
  1. in section “troubleshooting”:
    • min node version is listed as 18, seems to be nodejs 20 now:
      • nodejs_18 fails: Error: tsx must be loaded with --import instead of --loader
      • nodejs_20 works ok
  • upgrade minimum node version in docs
  1. in section “Configure the Wallet”
    • iota/apps/wallet/configs/environment/.env.defaults doesn’t seem to exist anymore in the repo. Is it meant to be generated ?
    • is API_ENV=local the only value we need in env for now ? or do the next commands need more values that were previously in .env.defaults ?
    • 12 additional files refer to it and try to load it, should we remove the references to it ?
  • fix missing info or files
  1. in section “Generate example data”
    • what is this data ? I suppose transactions and objects ? Why do we need it ?
    • where is the section “Prerequisites for Building Apps locally” ? It doesn’t seem to show up in a search
      • possible fix: make the text a link to the section
    • does the command “pnpm --filter @iota/iota-sdk test:e2e” generate this data or run end-to-end tests ? Or does running end-to-end tests generate data that we can later use to write manual tests using the Typescript SDK ?
  • clarify this part of the docs

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 8, 2025
@iota-ci iota-ci added core-protocol node Issues related to the Core Node team labels Jan 8, 2025
@nmrshll nmrshll self-assigned this Jan 9, 2025
@nmrshll nmrshll force-pushed the devx/docs-feedback-github.com/iotaledger/devx/issues/517 branch from e60823e to 256230c Compare January 9, 2025 11:10
@nmrshll nmrshll force-pushed the devx/docs-feedback-github.com/iotaledger/devx/issues/517 branch from 256230c to d234ca3 Compare January 9, 2025 11:12
@nmrshll nmrshll marked this pull request as ready for review January 9, 2025 11:13
@nmrshll nmrshll requested a review from a team as a code owner January 9, 2025 11:13
Copy link
Contributor

github-actions bot commented Jan 9, 2025

✅ Vercel Preview Deployment is ready!

View Preview

@lucas-tortora
Copy link
Contributor

@nmrshll Thanks for picking this up!

I think we can probably create a new issue to address the open doubts so it doesn't block merging this PR, WDYT?

@muXxer
Copy link
Contributor

muXxer commented Jan 14, 2025

@nmrshll @lucas-tortora so what happens to this PR now?
I would suggest that DevX creates new issues for the missing things if they agree and approves the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-protocol documentation Improvements or additions to documentation node Issues related to the Core Node team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs feedback: Update / fix docs page for "Local development"
4 participants