Motivation

Copilot by Detox (official name now? 🙂 ) currently lacks proper community engagement and visibility for contributors and other frameworks. A README with basic instructions in the repo is insufficient to drive this project forward as a community-led effort.

The primary motivation for a dedicated documentation website is to centralize all relevant information about Copilot, making it easier to:

• Provide comprehensive guides and API references for integrating Copilot into various frameworks.
• Showcase best practices and technical overviews for users and contributors.
• Encourage other frameworks and developers to participate by offering clear guidelines and collaboration opportunities.

By creating a documentation site, we can present Copilot as a robust, community-friendly tool while showcasing its capabilities and extensibility.

TODOS

• Establish a Docusaurus site under the detox-copilot repo.
• Organize and collect all relevant documentation under "API" and "Guides" sections.
• Introducing a Showcase page (TBD?)
• Publish the site (to be done together after a code review).

Establish a Documentation Site

Requirements:

• Create a Docusaurus site within the detox-copilot repository, preferably under a website folder.
• Refer to the Docusaurus documentation for setup instructions.

Theme & Design:

• Use the same colors as the Detox documentation site.
• Copy only necessary CSS files and design elements from Detox website.
  • Avoid including unnecessary homepage sections (e.g., Blogs or Showcase).
• The homepage should remain minimal, containing only the Copilot demo.
  • Demo reference: Detox Copilot Demo.

Structure:

1. Guides Section:

   • Integrating with Testing Frameworks:
     Explain Copilot’s robustness and link to relevant API pages. Include an overview of the driver and capabilities.
   • Technical Overview:
     Adapt from Detox docs; remove it from Detox once integrated here.
   • Copilot Best Practices:
     Adapt from Best Practices for Copilot, emphasizing standalone step-by-step guidance. Try to remain framework-agnostic while explaining but it's OK to show some examples based on Detox.
   • Implementing a Custom Testing Framework Driver:
     Detail how to add drivers.
   • Contributing to Copilot by Detox:
     • Provide guidance for adding prompt handlers and drivers.
     • Highlight Detox-specific practices and locations for drivers (src/drivers) and prompt handlers (src/prompt-handlers).
     • Link to issues section for contribution ideas.

2. API Section:

   • Basic Interface Overview:
     Cover lifecycle commands like init, start, perform, and end.
   • Prompt Handler:
     • Describe how to write a prompt handler.
     • Link to open tasks for contributors interested in adding prompt handlers (src/prompt-handlers). (here)
   • Framework Driver:
     • Explain how to implement custom drivers for different testing frameworks.
     • Clarify optional support for Snapshot.
     • Refer to relevant types files in the source code.

   Reference API structure: Detox API Docs.

3. Showcase Page (or "Use Cases"):

   • Initially, highlight Detox as the only use case.
   • Emphasize openness for collaboration with other frameworks.

Resources:

• Docusaurus Documentation
• Detox Copilot Documentation
• Detox Website Code