read-doc

Fetch official documentation before writing or modifying code. Use when user says "using X", "with X library", "create/build/implement/fix/update/refactor something with X", "help me with X", or mentions any library/framework/package name (like gsap, framer-motion, three.js, zustand, zod, etc.) and wants to write, modify, fix, or update code.

Safety Notice

This listing is imported from skills.sh public index metadata. Review upstream SKILL.md and repository scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "read-doc" with this command: npx skills add wxul/read-document-skill/wxul-read-document-skill-read-doc

Documentation Reference Generator

This is a pre-step for code generation. Fetch documentation and produce a technical reference summary that will be used for subsequent code generation.

Trigger

When user requests to generate or modify code using a specific technology/library/framework.

Workflow

Step 1: Confirm Documentation URL

Based on the technology name, suggest the official documentation URL.

Ask user with options:

I'll fetch documentation from: [url]

  • Yes - proceed with this URL
  • Use different URL - provide an alternative URL
  • Ignore - skip this step, proceed without documentation reference

If user selects Ignore, skip this skill entirely and proceed to code generation using existing knowledge.

Only ask once per technology in a session.

Step 2: Fetch Documentation

Use WebFetch to retrieve the entry page. Extract:

  • Navigation links (sidebar, table of contents)
  • Link titles and URLs

If WebFetch fails (domain blocked, network error, etc.), inform the user:

Unable to fetch documentation from [url].

Options:

  • Try different URL - provide an alternative documentation URL
  • Skip - proceed without documentation reference

Do not retry the same URL. If user provides alternative URL and it also fails, skip documentation fetch and proceed with existing knowledge.

Step 3: Navigate to Relevant Page

Based on user's code requirement, match keywords with link titles and fetch the specific sub-page(s) that are most relevant.

Step 4: Generate Technical Reference Summary

Extract and summarize from the documentation:

  • Relevant API signatures and parameters
  • Usage patterns and examples
  • Best practices and recommendations
  • Common pitfalls to avoid

Step 5: Output

Produce a technical reference summary:

## Technical Reference: [technology]

### Source
- [documentation URL]

### Relevant APIs
[API signatures, parameters, return types]

### Usage Patterns
[Code examples from docs]

### Best Practices
[Recommendations from docs]

### Notes
[Important caveats or version-specific info]

This summary will be used as reference for the subsequent code generation step.

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

General

generate-image

No summary provided by upstream source.

Repository SourceNeeds Review
General

read-doc

No summary provided by upstream source.

Repository SourceNeeds Review
Coding

Github Push

Secure GitHub push automation with auto SSH and remote config. Use when git push, automated push, or conflict handling needed.

Registry SourceRecently Updated