Skip to content

docs: improve local development instructions - #133

Merged
bmuenzenmeyer merged 5 commits into
nodejs:mainfrom
ojedaJD:jo/improve-development-docs
Sep 22, 2026
Merged

bmuenzenmeyer merged 5 commits into
nodejs:mainfrom
ojedaJD:jo/improve-development-docs

Conversation

@ojedaJD

@ojedaJD ojedaJD commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Refs #127 and #128.

Documents the Node.js version requirement from .nvmrc, static build steps, local serving command, preview URL, and rebuild workflow. Local builds now generate localhost asset URLs while Vercel preview and production builds retain their deployment origins.

Signed-off-by: JD De Dios Ojeda <89946133+ojedaJD@users.noreply.github.com>
@ojedaJD
ojedaJD requested a review from a team as a code owner August 28, 2026 18:34
@vercel

vercel Bot commented Aug 28, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
nodejs-learn Ready Ready Preview Sep 22, 2026 6:25pm UTC

Request Review

@github-actions

Copy link
Copy Markdown

👋 Codeowner Review Request

The following codeowners have been identified for the changed files:

Team reviewers: @nodejs/nodejs-website

Please review the changes when you have a chance. Thank you! 🙏

@avivkeller avivkeller left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't resolve the mentioned issue

@AugustinMauroy

Copy link
Copy Markdown
Member

agree with aviv but the content is better IMO

Signed-off-by: JD De Dios Ojeda <89946133+ojedaJD@users.noreply.github.com>
@ojedaJD

ojedaJD commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the feedback! I updated the PR to fix the underlying issue. Local builds now use localhost for asset URLs, while preview and production builds keep their existing URLs. I tested the local build, and everything loads correctly.

Comment thread doc-kit.config.mjs
Comment thread CONTRIBUTING.md Outdated
@avivkeller

Copy link
Copy Markdown
Member

I don't think this is an improvement, it's just rewording for the sake of rewording

@bmuenzenmeyer bmuenzenmeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is an improvement, it's just rewording for the sake of rewording

It absolutely is an improvement, especially the mention to serve and the localhost origin. The referenced issues came out directly from sitting with a Code and Learn attendee that tripped up on these two points.

The comment about Node 24 is valid and should be normalized.

Comment thread CONTRIBUTING.md Outdated
Comment thread README.md Outdated
Signed-off-by: JD Ojeda <jddedios.ojeda@gmail.com>
@bmuenzenmeyer

Copy link
Copy Markdown
Contributor

@avivkeller are you okay with the latest changes?

@ojedaJD
ojedaJD requested a review from avivkeller September 1, 2026 14:30
@bmuenzenmeyer

Copy link
Copy Markdown
Contributor

@avivkeller the hard block got replaced by your second review - can you let us know if your are still okay with the approach here?

@mikeesto mikeesto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just need to accept the recent changes in doc-kit.config.mjs

Signed-off-by: Brian Muenzenmeyer <brian.muenzenmeyer@gmail.com>
@bmuenzenmeyer
bmuenzenmeyer added this pull request to the merge queue Sep 22, 2026
Merged via the queue into nodejs:main with commit a13ba71 Sep 22, 2026
2 checks passed
@jonasgeiler

jonasgeiler commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Uhm, I think this broke production?
The live https://nodejs.org/learn site is doing requests like https://https//nodejs.org/learn/assets/fonts/open-sans-latin-wght-normal.woff2 right now.
@bmuenzenmeyer

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor

Ugh. I'm at swimming lessons right now. Will ping someone in slack

@jonasgeiler

Copy link
Copy Markdown
Contributor

@bmuenzenmeyer oh okay, I opened #143 to hopefully fix it asap!

This branch was successfully deployed

1 active deployment
Preview 92c44e91 Deployed Sep 22, 2026 by vercel[bot]
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.

8 participants