Docusaurify documentation #6
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
Shamelessly stolen from cardano-updates settings
dnadales
approved these changes
Feb 8, 2023
| @@ -22,4 +22,39 @@ document](CONTRIBUTING.md). | |||
| Issues can be filled in our [GitHub issue | |||
| tracker](https://github.com/input-output-hk/ouroboros-consensus/issues). | |||
|
|
|||
| ## Installation | |||
There was a problem hiding this comment.
Perhaps this should be a sub-section of Documentation: once we add the Consensus code this could lead to confusion.
There was a problem hiding this comment.
We shall rewrite the README when we merge consensus code in this repo, I guess/
| ### Local Development | ||
|
|
||
| ``` | ||
| $ yarn start |
There was a problem hiding this comment.
I wonder if we should add a .nix file that provides a yarn installation (I could do it in a separate PR). I found it quite handy!
There was a problem hiding this comment.
Definitely a good idea, and something easy to do (even I could do it :) )!
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 PR uses docusaurus to structure the documentation site. This PR is still in draft because I need to add github actions to publish it with the new style.