0.3.2 release + docs cleanup #185
Merged
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
src/commands/cmd_help.nim
Outdated
| else: | ||
| let toCheck = [arg, "core-" & arg, "howto-" & arg, "guide" & arg] | ||
| let toCheck = [arg, arg & ".md" & "core-" & arg, "howto-" & arg, "guide" & arg] |
There was a problem hiding this comment.
are you missing a comma , here? i think this line should be as follows correct? With a , after the new item of arg & ".md" you are looking to match on ?
let toCheck = [arg, arg & ".md", & "core-" & arg, "howto-" & arg, "guide" & arg]
There was a problem hiding this comment.
good spot. thanks. updated
MyNameIsMeerkat
requested changes
Feb 1, 2024
* most of the docs were out of date and just added to the confusion where a doc should be updated - in this repo or in the docs site repo * during release process docs will be copied to chalk so that chalk binary can ship with embedded docs as expected. * moved release notes to `CHANGELOG.md` in the root of the repo. This is a common pattern in GitHub and will make discovering changelog in the repo a lot easier. To be able to embed it in the chalk binary, `make` ensures to copy it to `src/docs` on build time.
MyNameIsMeerkat
previously approved these changes
Feb 2, 2024
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.
Issue
chalk repo has outdated docs which is confusing where docs should be fixed
Description
CHANGELOG.mdin the root of the repo. This is a common pattern in GitHub and will make discovering changelog in the repo a lot easier. To be able to embed it in the chalk binary,makeensures to copy it tosrc/docson build time.Testing
no functional change. just build process change