docs: add local setup instructions to README - #49
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing local (Node.js) setup instructions to the root README, alongside the existing Docker workflow, so developers can choose a faster local option or a containerized option.
Changes:
- Adds a brief “Local vs Docker” recommendation at the top of the setup section.
- Introduces a new Local section with Node.js +
npmcommands to run the docs dev server. - Reformats the Docker instructions into a fenced shell block and consolidates the localhost URL note.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
README.md:20
- The README says Node.js "24+", which suggests Node 25+ is supported. Since CI and the Docker image are pinned to major 24, recommending 24.x avoids encouraging a potentially incompatible major version.
Requires [Node.js](https://nodejs.org/) 24+ (same major version used in CI/Docker).
Add a Node.js quick-start alongside the existing Docker section, with an upfront guide on when to use each. Signed-off-by: Artem Kovalov <artem.kovalyov@gmail.com>
artemkovalyov
force-pushed
the
docs-readme-local-setup
branch
from
August 28, 2026 21:50
d7b818a to
82a2e42
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Suppressed comments (2)
README.md:20
- The stated Node.js requirement (18+) doesn’t match the version used by this repo’s CI (Node 24 in .github/workflows/static.yml), which can confuse contributors when they hit version-specific issues. Consider documenting the CI/recommended version alongside the minimum supported version.
Requires [Node.js](https://nodejs.org/) 18+.
README.md:23
- To keep local setup aligned with the repo’s package-lock and CI (which runs
npm ci), prefernpm cihere for a reproducible install.
npm install
| npm run docs:dev | ||
| ``` | ||
|
|
||
| ### Docker |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan