cypress-docs

Cypress Documentation

Purpose

Enable the agent to retrieve accurate, up-to-date, and verifiable information about the Cypress testing framework by prioritizing official documentation and structured sources.

When to use

Apply this skill whenever the task depends on finding, reading, or quoting Cypress documentation rather than general testing intuition:

• Look up facts: commands, APIs, assertions, lifecycle hooks, configuration options, environment variables, CLI flags, plugins, or TypeScript types as documented by Cypress.
• Confirm behavior: how something works in a given Cypress version, E2E vs component testing differences, browser support, or networking/cy.intercept semantics.
• Before asserting “Cypress can/cannot…”: search docs first; do not rely on memory for exact signatures, defaults, or deprecated APIs.
• Extract structured content: follow the LLM-optimized docs strategy below (llms.txt, /llm/*) when fetching or summarizing doc pages.
• Ground answers for others: when explaining Cypress to a user, writing examples, or reviewing code where correctness must match official docs.

If the user only needs writing or fixing tests without a documentation lookup, prefer cypress-author; if they only need test explanation without fetching docs, prefer cypress-explain. Use this skill when official documentation is the source of truth.

Source Prioritization

Primary Sources (ALWAYS search first)

• https://docs.cypress.io
• https://www.cypress.io

🤖 LLM-Optimized Docs Strategy

When accessing docs.cypress.io:

1. Fetch /llms.txt

2. Parse it to discover:

   • LLM-friendly documentation paths
   • Structured content endpoints

3. Prefer content under /llm/*. Every path on the site has an optimized version hosted under /llm - for example, https://docs.cypress.io/app/faq is available at https://docs.cypress.io/llm/markdown/app/faq.md.

4. Why:

   • Markdown / JSON format
   • Cleaner structure
   • Less noise than HTML