Skip to content

DOC-6360 make sure command lists and code examples appear correctly in .md pages#2896

Merged
andy-stark-redis merged 11 commits intomainfrom
DOC-6360-cmd-list-fix
Mar 18, 2026
Merged

DOC-6360 make sure command lists and code examples appear correctly in .md pages#2896
andy-stark-redis merged 11 commits intomainfrom
DOC-6360-cmd-list-fix

Conversation

@andy-stark-redis
Copy link
Contributor

@andy-stark-redis andy-stark-redis commented Mar 17, 2026

The shortcodes for the new command lists in the data type pages, some of the code examples and multitabs were not being handled correctly for the Markdown output (so they appeared in the output files as shortcodes). Now fixed, so if you look at the GET page, you should see the command list (as a table) and the examples and multitabs without any shortcodes.

Another fiver at the ready, btw :-)


Note

Medium Risk
Touches core Hugo templates/partials that generate .md outputs, so regressions could affect many pages’ rendered content and metadata, though changes are limited to documentation rendering logic.

Overview
Fixes Markdown export rendering so pages no longer leak Hugo shortcodes into the generated .md output. The single.md/section.md pipeline now handles escaped shortcode forms, runs additional expansion passes for command-group and multitabs, and only strips remaining shortcodes after unescaping entities (including + to +).

Replaces TOC generation from toc-json-regex.html to a new toc-from-markdown.html that derives ##/### headings directly from .RawContent. Updates markdown-code-examples.html to better normalize code-fence languages and to support self-closing clients-example shortcodes, emitting fully expanded, AI-friendly Markdown sections.

Written by Cursor Bugbot for commit 997940a. This will update automatically on new commits. Configure here.

@andy-stark-redis andy-stark-redis requested a review from a team March 17, 2026 13:40
@andy-stark-redis andy-stark-redis self-assigned this Mar 17, 2026
@andy-stark-redis andy-stark-redis added the AI-friendliness Features that help AI tools understand and use the doc pages more easily. label Mar 17, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2026

DOC-6360

@jit-ci
Copy link

jit-ci bot commented Mar 17, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just one comment: I don't see the API method information in the html.md file. Maybe that's by design.

I'm in a good mood this morning, so this one is on the house. :)

@andy-stark-redis
Copy link
Contributor Author

@dwdougherty Thanks, I'll have a look at that (I don't think it's by design but I'll check).

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

@andy-stark-redis
Copy link
Contributor Author

Finally! Domo arigato, Mr Bugboto.

@andy-stark-redis andy-stark-redis merged commit fcbede0 into main Mar 18, 2026
46 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6360-cmd-list-fix branch March 18, 2026 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI-friendliness Features that help AI tools understand and use the doc pages more easily.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants