docs: mdbook guide #726
Open
docs: mdbook guide #726
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
Operator installation
chain MMR faq
Mirko-von-Leipzig
force-pushed
the
mirko/docs
branch
from
6f0e345 to
e22ce86
Compare
phklive
approved these changes
Mar 4, 2025
Mirko-von-Leipzig
force-pushed
the
mirko/docs
branch
from
8cf9bd0 to
c0ec5ee
Compare
|
I've updated the PR with some minor changes. As discussed offline I'll leave this targeting |
.github/workflows/book.yml
Outdated
Comment on lines
55
to
56
| # Only run deployment on push to main/next branches, not on PRs | ||
| if: github.event_name == 'push' || github.event_name == 'workflow_run' |
There was a problem hiding this comment.
This means pushes to main and next will overwrite each other. Probably we would want this to only happen on next so that they're always the latest dev docs.
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 adds an
mdbookdoc guide for node operators and developers.I've been staring at this for a bit too long; I think I've developed blind spots. Happy with any feedback.
Note: this includes a
mermaid.jsdiagram - I'm not sure its that nice, there are maybe better formats to choose instead.Closes #244