Fix configuration documentation site #4842
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
A demonstration of the fix is included in the PR associated with this commit.
See https://gushiermainecoon.htmlpasta.com/ for a demo of this change. Part of rust-lang#4178
Separates out search and direct linking, uses header ids for direct linking and `?search=term` for filtering configurations. Once the app mounts the page is scrolled to the current header set in the url hash.
* Adds query param for version no This adds support for using a query parameter for selecting the version no * Adds error handling to configuration request Catch request exception in case fetching the configuration from the url fails, this can happen either if non existent version number is passed in or because of server issues. * Makes version selection better Covers a few common cases in which the version number can be specified.
- Preserve search and version parameter updates in the url - Render headings with an anchor to itself for easier linking to config options, variants, etc. Demo: https://5efeb81ca3f0d.htmlsave.net/
I broke this a few weeks ago so I'll fix it Demo: https://5f0fa445faca4aff5f580029--naughty-borg-09b903.netlify.app/?version=master&search=#brace_style
Older tags of the repo don't have the configuration.md file that the docs/index.html file uses to display configuration options. Removing them from the list since they don't apply to the use case of the documentation page.
Signed-off-by: gunadhya <6939749+gunadhya@users.noreply.github.com>
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 got out of sync when we swapped the default branch (refs #4801) so cherry-picking the various commits that had improved our configuration documentation site on the 2.0 rc branch