Skip to content

docs: update documents for sanity check#221

Merged
ktro2828 merged 1 commit into
mainfrom
docs/sanity
Nov 14, 2025
Merged

docs: update documents for sanity check#221
ktro2828 merged 1 commit into
mainfrom
docs/sanity

Conversation

@ktro2828

Copy link
Copy Markdown
Collaborator

What

This pull request enhances the documentation for the sanity checking 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 the sanity module, detailed explanations of CLI outputs and exit codes, and normalization of severity naming conventions.

Documentation Additions and Improvements:

  • Added a new tutorial (sanity.md) that explains how to use the sanity_check function, display results, save outputs, and implement custom checkers. This makes it easier for users to understand and extend sanity checks.
  • Introduced a new API reference section for t4_devkit.sanity, including filtering options and improved navigation in the documentation. [1] [2]
  • Updated the CLI documentation for t4sanity to explain exit status logic, provide a detailed description of the JSON output format, and clarify result table columns. [1] [2]

Schema Documentation Standardization:

  • Standardized all rule severity labels in requirement.md to uppercase (ERROR, WARNING) for consistency across documentation.

Navigation and Organization:

  • Updated the documentation navigation (mkdocs.yaml) to include the new tutorial and API reference for sanity, improving discoverability.
  • Removed a duplicate or misplaced reference to t4_devkit.common.sanity in the common API documentation for clarity.

Copilot AI review requested due to automatic review settings November 14, 2025 06:02

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 14, 2025
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
@ktro2828 ktro2828 merged commit a1df8d6 into main Nov 14, 2025
4 of 5 checks passed
@ktro2828 ktro2828 deleted the docs/sanity branch November 14, 2025 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants