docs: update documents for sanity check#221
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation for the sanity checking functionality by adding comprehensive tutorials and API references, improving CLI documentation clarity, and standardizing severity level naming conventions across schema requirements.
Key Changes:
- Added a new sanity check tutorial with usage examples and instructions for implementing custom checkers
- Enhanced CLI documentation with detailed exit status logic, JSON output format descriptions, and result table explanations
- Standardized all severity levels to uppercase (
ERROR,WARNING) throughout schema documentation
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yaml | Added navigation entries for the new sanity tutorial and API reference |
| docs/tutorials/sanity.md | New tutorial documenting sanity check usage and custom checker implementation |
| docs/schema/requirement.md | Standardized severity level casing from mixed case to uppercase |
| docs/cli/t4sanity.md | Enhanced with exit status logic table and JSON format field descriptions |
| docs/apis/sanity.md | New API reference page for the sanity module with filtering options |
| docs/apis/common.md | Removed duplicate sanity reference from common API documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
f8ea67a to
fa3db5a
Compare
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 enhances the documentation for the
sanitychecking functionality, improves clarity in the CLI documentation, and standardizes rule severity levels across the schema requirements. The most significant changes include the addition of a dedicated tutorial for sanity checks, a new API reference section for thesanitymodule, detailed explanations of CLI outputs and exit codes, and normalization of severity naming conventions.Documentation Additions and Improvements:
sanity.md) that explains how to use thesanity_checkfunction, display results, save outputs, and implement custom checkers. This makes it easier for users to understand and extend sanity checks.t4_devkit.sanity, including filtering options and improved navigation in the documentation. [1] [2]t4sanityto explain exit status logic, provide a detailed description of the JSON output format, and clarify result table columns. [1] [2]Schema Documentation Standardization:
requirement.mdto uppercase (ERROR,WARNING) for consistency across documentation.Navigation and Organization:
mkdocs.yaml) to include the new tutorial and API reference forsanity, improving discoverability.t4_devkit.common.sanityin the common API documentation for clarity.