Skip to content

Improve local dev environment setup documentation#7927

Open
goelakash wants to merge 1 commit into
jupyter:mainfrom
goelakash:docs/dev-setup-guide
Open

Improve local dev environment setup documentation#7927
goelakash wants to merge 1 commit into
jupyter:mainfrom
goelakash:docs/dev-setup-guide

Conversation

@goelakash
Copy link
Copy Markdown

Addresses #7701 and #7029.

Summary

  • Adds a Prerequisites table with required Python/Node.js versions
  • Provides three setup paths: pixi (recommended), mamba/conda, and pip + yarn/npm (no conda)
  • Adds dev server flags for local development (--no-browser, --ServerApp.token='', --NotebookApp.allow_origin='*')
  • Adds a Verifying your setup section
  • Adds a Troubleshooting section covering common issues:
    • jlpm: command not found
    • JavaScript build failures
    • ModuleNotFoundError
    • Node.js version mismatch
    • Pre-commit hooks not running

Test plan

  • Verify instructions work on a fresh clone with pixi
  • Verify instructions work with pip + yarn (no conda)
  • Confirm rendered markdown looks correct on GitHub

@github-actions
Copy link
Copy Markdown
Contributor

Binder 👈 Launch a Binder on branch goelakash/notebook/docs%2Fdev-setup-guide

@goelakash goelakash force-pushed the docs/dev-setup-guide branch 2 times, most recently from 506ed94 to 6585088 Compare May 24, 2026 03:11
@goelakash
Copy link
Copy Markdown
Author

goelakash commented May 24, 2026

Could a maintainer please add the documentation label? The triage check requires it and I don't have permission to add labels on the PR

Add prerequisites table (Python >= 3.10, Node.js 22.x), two additional
setup paths (pixi, pip+yarn/npm) alongside the existing mamba
instructions, dev server flags for local development, and a
troubleshooting guide for common issues.

Preserves all original content and wording.

Addresses jupyter#7701 and jupyter#7029.
@goelakash goelakash force-pushed the docs/dev-setup-guide branch from 8c6b6ca to 8a2a173 Compare May 31, 2026 21:16
@goelakash
Copy link
Copy Markdown
Author

@jtpio let me know if this pr has any major issues to address - i think the language/detail is subject to your review, but the rest is something I can take care of based on your opinions

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.

1 participant