Skip to content

[docs] Fix various syntax and rendering errors #1001

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant