Deploy to production #4066
Merged
Deploy to production #4066
Conversation
This file contains hidden or 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
We now use Asciidoc's shorthand for IDs (e.g. `[#some_id_here]`, see https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#ids-roles-and-options) but this isn't being picked up by the script that builds nav.json used to build the site-wide table of contents. This meant that sections of the Pico SDK had incorrect anchors inferred from their titles rather than the Asciidoc source where they would of the form `group_hardware_base`, etc. Fix this by adding a branch to detect shorthand IDs as well as the "anchor" syntax of `[[some_id_here]]`.
To reduce the number of elements included on every single page of the documentation site, no longer include subsections of every section (e.g. terminate at Pico C SDK > Hardware APIs > hardware_adc, rather than also including the subsections of "Detailed Description", "Functions", etc.) as these are available in the right-hand "On this page" TOC shown on wide-enough screens. Note we're not yet cutting down the amount of markup to render the TOC but starting by cutting out the source data. This removes the JavaScript logic to render the currently clicked section in bold.
Don't include subsections in site-wide table of contents
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.
No description provided.