Add npm script docs #1
Open
Conversation
This file contains 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
Rob-Hazelcast
approved these changes
Jan 14, 2025
| ./node_modules/.bin/check-orphan-pages -d tutorials --log-failure-level error | ||
| ``` | ||
|
|
||
| Or they can be called as `npm` scripts. For that to work you need to add the `check-orphan-pages` command to the `scripts` section of the `package.json`: |
There was a problem hiding this comment.
Is there a good reason not to include this in the package.json file in the repo now?
| | `--directory`, `-d` | set the root folder of documentation, if there are several root directories, can take a coma separated list, e.g. `-d docs,tutorials` | `"docs"` | | ||
| | `--log-failure-level` | if set to `"error"` exits process with `1` if orphan pages are detected | `undefined` | | ||
| | `--directory`, `-d` | set the root folder of documentation, if there are several root directories, can take a coma separated list, e.g. `-d docs,tutorials` | `docs` | | ||
| | `--log-failure-level` | if set to `error` exits process with `1` if orphan pages are detected | `undefined` | |
There was a problem hiding this comment.
We'll probably want this to be the default behavior once we've tested it on all the repos, but sensible to avoid breaking builds for now.
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.
Detailed docs on how to launch executables