doc-lookup

Solid

Check official docs when framework APIs or configuration may be version-sensitive.

AI & Automation 113 stars 26 forks Updated 1 months ago MIT

Install

View on GitHub

Quality Score: 83/100

Stars 20%
68
Recency 20%
75
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

<!-- This is a SCAFFOLD skill --> <!-- If this file has NOT been customized, the AI should treat it as generic guidance. --> # Doc Lookup ## When to Apply - **Classification**: feature, architecture-change, hotfix, quick-win - **Phase**: /implement (before writing code), /review (verify API usage correctness) - **Trigger**: Task uses any framework/library listed in the project ADR's tech stack ## Conventions > **Customize after /app-init**: Replace these generic conventions with your project's specific doc lookup rules. ### Hard Rule > **MUST check official documentation before implementing.** Do NOT rely on training data for framework APIs, configuration options, or CLI commands. Training data may be outdated or inaccurate. When in doubt, fetch the doc page — the cost of one WebFetch is far less than the cost of debugging a hallucinated API. #### When to Fetch You **MUST** use WebFetch or WebSearch to consult official documentation when: 1. **Using a framework API you are not 100% certain about** — method signatures, parameter names, return types, default values 2. **Configuring framework-specific settings** — config files, environment variables, build options 3. **Implementing patterns that are framework-version-sensitive** — routing, middleware, hooks, lifecycle methods 4. **Encountering an error from a framework** — check the official troubleshooting/migration guide before guessing a fix 5. **The user explicitly asks you to check docs** — do it immediately, no e...

Details

Author
KbWen
Repository
KbWen/agentic-os
Created
5 months ago
Last Updated
1 months ago
Language
Python
License
MIT

Related Skills