ui-change-check

To check for missing help articles before a pull request, analyze your git diff against the main branch. This process identifies stale or missing user-facing documentation and route registration issues, ensuring UI documentation stays completely in sync with your code changes.

Verifying UI documentation consistency involves analyzing code changes related to UI components and route files. This check ensures all help articles, route registrations, and documentation structures are current and complete, preventing outdated user-facing navigation updates.

Yes, you can use a git diff to find outdated route registrations. By analyzing the diff versus main, the system identifies missing or stale help articles and route registration updates, allowing you to resolve navigation and documentation gaps before merging.

You need to run a pre-PR documentation check when you add a new page or modify navigation. This sweep identifies all related missing component documentation or help structure definitions, reducing the need for post-merge updates to user-facing artifacts.

Yes, the documentation check works without external dependencies. It directly analyzes your branch changes to review UI-related documentation artifacts, requiring no additional modules to identify missing help articles or route registration issues.

A limitation of checking help structure definitions is that the analysis focuses strictly on identifying missing or stale artifacts based on the git diff. It does not automatically generate the missing documentation, requiring developers to manually update the identified articles and route registrations.