fix: correct the docs version in the README #627
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: pratik-mahalle <[email protected]>
|
No significant changes currently retry |
There was a problem hiding this comment.
Pull Request Overview
This PR corrects documentation version references in the README to align with the current versioned documentation structure. It updates Vale linting command examples to point to the correct documentation version directory.
Key changes:
- Updated Vale command examples from
version-2.0.0toversion-3.0.0in README.md - Ensured documentation instructions reference the current version directory
Signed-off-by: pratik-mahalle <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Description
📝 Fix: Update Documentation Version References in README
What changed:
version-2.0.0toversion-3.0.0Why this change was needed:
This fix ensures that the README instructions are accurate and point to the current documentation version. Users following the linting documentation instructions will now reference the correct versioned directory structure.
Files changed:
README.md- Updated Vale command examples fromversioned_docs/version-2.0.0/toversioned_docs/version-3.0.0/Type of change:
Testing:
This is a minor but important fix to keep the documentation accurate and prevent confusion for contributors who follow the README instructions for linting documentation.