Add documentation on how to build and run the project #304
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
ultrabug
requested changes
May 17, 2024
README.md
Outdated
| Serve the documentation: | ||
|
|
||
| ``` | ||
| hatch -e docs run mkdocs serve |
There was a problem hiding this comment.
docs is actually conflicting with the docs/ folder of the project which makes this command break, thanks for letting me see it :)
I'll open a PR to fix that first!
|
FYI #308 |
ultrabug
reviewed
May 17, 2024
Co-authored-by: Ultrabug <ultrabug@users.noreply.github.com>
Co-authored-by: Ultrabug <ultrabug@users.noreply.github.com>
ultrabug
reviewed
May 18, 2024
|
I added it to the documentation. |
1 similar comment
|
I added it to the documentation. |
|
Thanks mate, moving on |
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.
This fixes #303
Hatch looks nice!