read-software-docs
Read and navigate software package documentation websites. Use when the user provides a documentation URL and wants to understand an API, SDK, framework, or library. Triggers on requests like "read the docs at [url]", "look up [topic] in the [package] documentation", "what does [API] do according to the docs", or any task requiring fetching and comprehending online software documentation. Supports any HTML-based documentation site including Sphinx, Doxygen, ReadTheDocs, MkDocs, and custom doc sites. Common targets include NVIDIA Isaac Sim, Omniverse Kit, OpenUSD, ROS 2, PyTorch, and similar so
npx skills add majiayu000/claude-skill-registry --skill read-software-docs --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# Read Software Docs Fetch, parse, and navigate software documentation websites to answer user questions or build understanding of APIs, SDKs, and frameworks. ## Script `scripts/fetch_docs.py` — run with the project venv: ``` .venv/bin/python3 <skill-dir>/scripts/fetch_docs.py <mode> <url> [options] ``` **Modes:** | Mode | Purpose | Key Options | |------|---------|-------------| | `page` | Fetch a single page as clean markdown | `--output FILE` | | `links` | List all internal doc links on a page | `--filter REGEX` | | `sitemap` | Crawl from a root URL, build page tree | `--depth N` (default 1), `--filter REGEX`, `--output FILE` | Dependencies (`beautifulsoup4`, `html2text`, `requests`) must be installed in the `.venv`. ## Workflow ### 1. Orient: discover the doc structure Start with `links` mode on the user's URL (or the doc site index) to see available pages: ```bash .venv/bin/python3 scripts/fetch_docs.py links <url> ``` Use `--filter` to narrow results when the link list is large: ```bash .venv/bin/python3 scripts/fetch_docs.py links <url> --filter "api|reference|python" ``` For broader discovery, use `sitemap` with shallow depth: ```bash .venv/bin/python3 scripts/fetch_docs.py
- Script
- Workflow
- 1. Orient: discover the doc structure
- 2. Read: fetch specific pages
- 3. Drill down: follow links as needed
- 4. Synthesize
- Tips
What does the read-software-docs skill do?
Read and navigate software package documentation websites. Use when the user provides a documentation URL and wants to understand an API, SDK, framework, or library. Triggers on requests like "read the docs at [url]", "look up [topic] in the [package] documentation", "what does [API] do according to the docs", or any task requiring fetching and comprehending online software documentation. Supports any HTML-based documentation site including Sphinx, Doxygen, ReadTheDocs, MkDocs, and custom doc sites. Common targets include NVIDIA Isaac Sim, Omniverse Kit, OpenUSD, ROS 2, PyTorch, and similar so
How do I install it?
Run `npx skills add majiayu000/claude-skill-registry --skill read-software-docs --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.