Raycast Extension Docs
Overview
Use the bundled Raycast documentation under references/ as the source of truth for APIs, patterns, and policies. Route requests to the right section, load only the needed files, and apply the guidance to the user's task.
Quick Routing
- •Start with
references/SUMMARY.mdto locate the right doc page. - •Use
references/README.mdfor the general introduction and platform overview. - •Use
references/basics/for step-by-step guides (getting started, create, debug, publish). - •Use
references/api-reference/for API details and component usage. - •Use
references/api-reference/user-interface/for UI components (List, Form, Detail, Action Panel, etc.). - •Use
references/ai/andreferences/api-reference/ai.mdfor AI extension guidance. - •Use
references/examples/for real-world extension patterns. - •Use
references/information/for terminology, manifest, lifecycle, file structure, best practices, tools, and security. - •Use
references/utils-reference/for utility helpers and patterns. - •Use
references/teams/for private/team extension workflows. - •Use
references/migration/andreferences/changelog.mdfor version changes and breaking updates. - •Use
references/faq.mdfor quick clarifications.
Working Approach
- •Identify the user's goal and map it to the most relevant section in
references/SUMMARY.md. - •Open the specific doc file(s) and extract only the details needed to answer or implement.
- •Cross-check API usage against
references/api-reference/and best practices inreferences/information/best-practices.md. - •When building UI, verify component props and patterns in
references/api-reference/user-interface/. - •When shipping or collaborating, confirm publish/team steps in
references/basics/orreferences/teams/.
Notes
- •Keep answers aligned with the docs; call out when guidance is inferred or when the docs are silent.
- •If the user asks about behavior changes, consult
references/migration/andreferences/changelog.md.