update-docs

Audit TypeScript declarations against docs and example files.

294|147|Updated May 27, 2018
One-click install
npx skills add https://github.com/SAP/fundamental-ngx --skill update-docs-sap
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/SAP/fundamental-ngx/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/SAP/fundamental-ngx --skill update-docs-sap

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the component API, causing confusion and maintenance pain. This Skill provides a structured approach to verify docs against the current public API and update examples accordingly.

Core Features & Use Cases

  • API-Documentation alignment checks between code and docs
  • Automated audit of inputs/outputs demonstrated in examples
  • Generated report with undocumented items, mismatches, and recommended fixes

Quick Start

Run the docs-sync tool against a component or docs directory to generate a sync report and proposed updates.

Frequently Asked Questions about update-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if my API documentation matches the source code?

Auditing API documentation involves comparing TypeScript declarations in libs/core and libs/platform against docs and examples. This generates a structured report surfacing missing documentation, mismatches, and recommended fixes for sync.

Why does my library documentation drift from the public API interface?

Documentation drifts from the public API when source code changes outpace doc updates. An audit compares TypeScript declarations with documentation files to surface undocumented items and mismatches, enabling targeted updates.

How do I update examples to match the current component API in TypeScript?

Run a CLI-driven docs-sync workflow against the component or docs directory to update examples. This validates inputs and outputs demonstrated in examples and proposes targeted updates to match TypeScript declarations.

Does the docs-sync audit work with components outside of libs/core and libs/platform?

The docs-sync audit specifically targets library components under libs/core and libs/platform. It compares TypeScript declarations with associated docs and example files, generating a structured report for these designated directories.

What is the best way to surface undocumented inputs and outputs in API examples?

An automated audit of API examples surfaces undocumented inputs and outputs by generating a structured report. This highlights missing documentation and mismatches, supported by a CLI-driven workflow for targeted updates.