read-software-docs

What problem does it solve?

This Skill helps users understand and navigate complex software documentation websites, making it easier to learn about APIs, SDKs, and frameworks.

Core Features & Use Cases

• Fetch Documentation: Retrieves content from any HTML-based documentation site.
• Link Discovery: Identifies and lists internal links within documentation to help users find relevant pages.
• Sitemap Generation: Crawls documentation sites to build a hierarchical overview of available content.
• Markdown Conversion: Converts fetched HTML content into clean, readable Markdown.
• Use Case: A developer needs to understand how to use a specific function in the NVIDIA Omniverse Kit. They provide the documentation URL, and the Skill fetches the relevant API reference page, extracts the key information, and presents it in an easy-to-understand format.

Quick Start

Use the read-software-docs skill to fetch and display the main content from the documentation page at https://docs.nvidia.com/isaac/isaac_sim/reference/api/core/index.html.