Update guide for pcli threshold #4215
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
cronokirby
approved these changes
Apr 15, 2024
conorsch
requested changes
Apr 15, 2024
There was a problem hiding this comment.
There's breakage here where the dynamic import for version/tag:
Error updating "{{ #include ../penumbra_version.md }}", Could not read file for link {{ #include ../penumbra_version.md }}
Solution is just to update the relpaths. I'll handle that as part of review. Ideally CI would have fallen down on this, too.
We weren't failing on the broken links in CI, but now we are. This solves most of our problems: broken `include` statements still don't throw an error, but they emit a warning. There's an upstream PR to mdbook to update this behavior, which I've +1'd. Also patches a few broken links here and there, related to reorg in GH #4215.
Evidently that's a thing, see rust-lang/mdBook#1094. Fixed the links for our docs throughout. |
conorsch
pushed a commit
that referenced
this pull request
Apr 17, 2024
Follow-up to #4215, in which we reorganized the guide for readability. Some of the existing content got shuffled into subroutes, and already one person in Discord has pointed out that we broken URLs. Tacking on some http redirects via mdbook [0]. [0] https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect
conorsch
pushed a commit
that referenced
this pull request
Apr 17, 2024
Follow-up to #4215, in which we reorganized the guide for readability. Some of the existing content got shuffled into subroutes, and already one person in Discord has pointed out that we broken URLs. Tacking on some http redirects via mdbook [0]. [0] https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect
conorsch
pushed a commit
that referenced
this pull request
Apr 17, 2024
Follow-up to #4215, in which we reorganized the guide for readability. Some of the existing content got shuffled into subroutes, and already one person in Discord has pointed out that we broken URLs. Tacking on some http redirects via mdbook [0]. [0] https://rust-lang.github.io/mdBook/format/configuration/renderers.html#outputhtmlredirect
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.
Describe your changes
Restructures
guide.penumbra.zoneto make it more useful and to open space forpclithreshold docs.Issue ticket number and link
Checklist before requesting a review
If this code contains consensus-breaking changes, I have added the "consensus-breaking" label. Otherwise, I declare my belief that there are not consensus-breaking changes, for the following reason: