docs: Enable Material capabilities for the published 2.2 user documentation - #375
Merged
Merged
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
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.
Description
Cherry-pick of #374 onto the 2.2 release line, so the published 2.2 documentation offers the same capabilities as
main. The three commits are identical to those on #374 and applied without conflicts.Configuration only, by design: this aligns the release line with
mainin theme and features, not content. After this changeuser-docs/mkdocs.ymldiffers frommainonly in the pre-existing nav entry for Virtual schemas, anduser-docs/overrides/main.htmlis byte-identical.Related Issue
SPOT-32682
Type of Change
docs: Documentation updateChanges Made
Markdown extensions:
admonition,attr_list,md_in_html,tocpermalinks, and thepymdownxset (details,emoji,highlight,inlinehilite,snippets,superfences,tabbed).Theme features:
content.code.copy/select/annotate,content.tooltips,navigation.instantplusprefetch/progress,navigation.tracking/top/footer,toc.follow,search.suggest/highlight/share,announce.dismiss.Outdated-version banner via
theme.custom_diranduser-docs/overrides/main.html.A separate content commit re-indents six fenced blocks in
cloud/aws.mdandcloud/azure.mdfrom three spaces to four, so they attach to their list items. See the notes below.Testing
task all)Test Details
<ol>each (3 and 5 steps), with the code blocks nested inside their list items.task docs-*targets, so the checks were run the way its CI does:mkdocs build --strictpasses, the 41 documentation tooling tests pass, andruff checkis clean.user-docs/uv.lockon this branch independently pins mkdocs-material 9.7.7, the same versionmainresolves to, so every enabled feature is supported here.Checklist
task fmtandtask lintuser-docs/for user-facing changes,doc/for contributor-facing changesCHANGELOG.mdfor user-facing changes, including examples for new features when usefulAdditional Notes
The 2.2 documentation carried the same latent defect as
main:cloud/aws.mdandcloud/azure.mdindented six fenced blocks by three spaces inside ordered lists, which stockfenced_codedoes not recognize. Those pages published the commands as inline text with a literalbashin front and no code block at all, and the same indentation split each ordered list so step numbering restarted at 1.Both symptoms are fixed here, matching #374 commit for commit. The built 2.2 AWS page now renders one continuous list of 3 steps with 2 real code blocks and no stray
bash, and the Azure page one list of 5 steps.The content commit is kept separate from the three configuration commits so the two concerns can be cherry-picked independently.
No
CHANGELOG.mdentry: this changes documentation-site presentation, not launcher behavior.