docs: how to build user docs locally #61
Merged
Conversation
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
Problem: It is not crystal clear how to run user documentation HTML files locally right after checking out this repository. Solution: - Add more examples on how to run the user-docu.sh script locally. - Show error messages if a mandatory variable (`NEOVIM_DIR`) is not set. Without `$NEOVIM_DIR`, the script will fail anyway because it would behave like running `make` after cd-ing to `$HOME`.
justinmk
changed the title
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.
Problem:
It is not crystal clear how to run user documentation HTML files
locally right after checking out this repository.
Solution:
Add more examples on how to run the user-docu.sh script locally.
Show error messages if a mandatory variable (
NEOVIM_DIR) is not set.Without
$NEOVIM_DIR, the script will fail anyway because it wouldbehave like running
makeafter cd-ing to$HOME.