chores: fix Markdown documentation issues #6
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.
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
.md
extension to files previously missing it, ensuring they are recognized and rendered correctly across various tools and environments.Impact
Testing
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.