docs: update document for the sanity#222
Merged
Merged
Conversation
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes the documentation for the t4sanity CLI tool by relocating two important sections ("Strict Mode" and "Exclude Checks") to appear earlier in the document, improving discoverability of key CLI options without modifying their content.
Key changes:
- Moved "Strict Mode" and "Exclude Checks" sections from the end of the document to immediately after the basic usage examples
- Repositioned these sections to appear before "Exit Status Logic" for better information hierarchy
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
github-actions
Bot
added
the
documentation
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
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.
What
This pull request reorganizes and clarifies the documentation for the
t4sanityCLI tool by moving the sections on "Strict Mode" and "Exclude Checks" to a more prominent location earlier in the file. The content of these sections remains unchanged, but their placement now improves readability and helps users find important options more easily.Documentation improvements:
docs/cli/t4sanity.md. [1] [2]