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

@goelakash goelakash commented May 24, 2026

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

github-actions Bot commented May 24, 2026

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 •
edited
Loading

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

This was referenced May 24, 2026
Open
Open
@goelakash
Improve dev environment setup docs in CONTRIBUTING.md
a1ccfb8 
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 6585088 to a1ccfb8 Compare May 24, 2026 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@goelakash goelakash

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@goelakash