Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ node scripts/download_dashboards.mjs

## Contributing to Documentation

When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. First generate the CLI documentation with `yarn docs:build`. Then in the `docs` folder, build the documentation locally with `yarn install` and serve with `yarn start`.
When submitting PRs for documentation updates, build and run the documentation locally to ensure functionality before submission. First generate the CLI documentation with `yarn docs:build`. Build and serve the documentation locally with `yarn docs:serve`.
Comment thread
jeluard marked this conversation as resolved.
Resolved

Your locally served documentation will then be accessible at http://localhost:3000/lodestar/.

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
"check-types": "lerna run check-types",
"check-spelling": "pyspelling -c .pyspelling.yml -v",
"docs:build": "lerna run check-readme && lerna run docs:build && ./scripts/prepare-docs.sh",
"docs:serve": "yarn --cwd docs install && yarn --cwd docs start",

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.

yarn --cwd docs install will this part be a no-op if dependencies are already installed?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Right, it will be almost instant and no-op (success Already up-to-date.). I used this approach to have a single command to serve the docs, even the first time.

"docs:lint": "prettier '**/*.md' --check",
"docs:lint:fix": "prettier '**/*.md' --write",
"test": "lerna run test --concurrency 1",
Expand Down