update-docs
Update Documentation: $ARGUMENTS
If $ARGUMENTS is empty, ask the user for a component path or folder before proceeding.
Verify that documentation examples are in sync with the component's current public API. If a path to a component is given, find its corresponding docs. If a docs path is given, find the component it documents.
Phase 1: Map component to docs
Component locations: libs/core/<component>/ or libs/platform/<component>/
Docs locations: libs/docs/core/<component>/ or libs/docs/platform/<component>/
Read:
- The component
.tsfile — extract allinput(),output(),model(),@Input(),@Output()declarations - The docs component (e.g.
<component>-docs.component.tsand.html) - All example files in the docs
examples/folder
Phase 2: Audit
More from sap/fundamental-ngx
migrate
Migrate a component or directive to Angular 21+ signal-based patterns
5best-practices
Audit existing code against project conventions and Angular 21+ best practices
5create-test
Generate or update unit tests for a component following project testing conventions
5a11y-audit
Audit a component for WCAG AA accessibility compliance
5review-pr
Review a pull request against project conventions and Angular 21+ best practices
5preflight
Run local quality gates before creating a PR
4