Skip to content

[docs] Fix various syntax and rendering errors #1233

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 24, 2025

Conversation

colleenmcginnis
Copy link
Contributor

Fixes various syntax and rendering errors that might include:

  • Fixing broken images
  • Hardcoding book-level substitution values
  • Fixing incorrectly closed blocks (admonitions, tab sets, code blocks, dropdowns etc.)
  • Fixing poorly migrated complex tables
  • Fixing poorly migrated lists
  • Fixing poorly migrated tab sets
  • Removing inline text formatting from directive titles where they won't be rendered (for example, inline code formatting in dropdown titles)
  • Specifying if a version is trying to communicate if a feature was added, deprecated, or coming (for example, during migration deprecated:[8.15.0] became [8.15.0], which doesn't give any information about what happened in 8.15.0)
  • Fixing nested dropdowns / definition lists
  • Fixing poorly migrated footnotes
  • Updating references to prerelease 9.0.0 versions (using a repo-level substitution until there is a solution to Add support for *-version attributes in the docs docs-builder#737)

@colleenmcginnis colleenmcginnis self-assigned this Apr 22, 2025
@colleenmcginnis colleenmcginnis marked this pull request as ready for review April 22, 2025 19:08
@colleenmcginnis colleenmcginnis requested a review from a team April 22, 2025 19:08
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🦁
Thanks for fixing these up!

@colleenmcginnis colleenmcginnis merged commit 8e066c7 into main Apr 24, 2025
4 of 5 checks passed
@colleenmcginnis colleenmcginnis deleted the fix-syntax-rendering-errors branch April 24, 2025 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants