Skip to content
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

chores: fix Markdown documentation issues #6

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dima-safin-2025
Copy link

@dima-safin-2025 dima-safin-2025 commented Aug 7, 2024

Overview

This PR addresses multiple issues in our Markdown documentation that could potentially affect the readability and correct parsing of our docs. Specifically, it corrects file extensions and improper HTML comment nesting.

Changes

  • Fix incorrect file extensions for Markdown documents
    • Added the .md extension to files previously missing it, ensuring they are recognized and rendered correctly across various tools and environments.
  • Fix improperly nested HTML comments in Markdown files and remove redundant typos
    • Corrected instances where HTML comments were nested, which could lead to parsing errors and unintended content display. Comments are now separated into distinct blocks.
    • Removed redundant typos which could lead to unclear or incorrect information being presented in the documentation. This ensures that all text is accurate and professional.

Impact

  • Ensures all Markdown files are recognized and handled correctly by editors and version control systems.
  • Prevents parsing errors in documentation due to improperly nested comments, improving document stability and readability.

Testing

  • All changes have been visually inspected in several Markdown editors (e.g., VSCode) to ensure proper rendering.
  • Links and comment blocks have been tested to confirm they do not produce any unintended effects.

Conclusion

Merging these fixes will significantly improve the maintenance and clarity of our documentation, making it easier for developers to work with and for tools to process our docs accurately.

@dima-safin-2025
Copy link
Author

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.

1 participant