docs-check-zh-cn

Check OpenHarmony API documentation consistency by running the bundled Python script to automatically detect mismatches between d.ts tags and Markdown fields. The script executes first to catch high-confidence template violations, missing permissions, and link issues before manual semantic review.

A template compliance audit verifies that public and system API docs include required labeled fields like permissions, model constraints, and system interface sections. It checks Markdown structures against expected templates and ensures error-code documents align with declared @throws codes in d.ts files.

Error-code docs fail consistency checks when required documentation blocks are missing or error-code coverage does not match the declared @throws codes in the d.ts interface declarations. The auditing script identifies these mismatches and reports them alongside template field coverage gaps.

Audit interface documentation by executing the consistency checking script to locate missing required fields like system interface sections, permissions, and model constraints. The script scans /docs and /interface paths to find template violations and produces an issues-only Markdown report with locations and suggested fixes.

Automated scripts cannot catch all documentation gaps reliably. The consistency checker runs automated checks first for high-confidence d.ts and Markdown mismatches, but manual semantic review is required to identify implementation alignment gaps that automation misses before producing the final issues report.