Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: create Docusaurus documentation site for Copilot by Detox #29

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: create Docusaurus documentation site for Copilot by Detox #29

wants to merge 2 commits into from

Commits on Nov 26, 2024

  1. docs: create Docusaurus documentation site for Copilot by Detox 

    This commit adds a new Docusaurus-based documentation site with:

### Guides Section:
- **Integrating with Testing Frameworks:** Overview of Copilot's capabilities.
- **Technical Overview:** Adapted from Detox docs (to be removed there).
- **Best Practices:** Framework-agnostic step-by-step guidance.
- **Custom Driver Implementation:** Guide to creating and adding testing framework drivers.
- **Contributing:** Details on adding prompt handlers and drivers, with tips and github link.

### API Section:
- **Interface Overview:** Lifecycle commands (`init`, `start`, `perform`, `end`).
- **Prompt Handlers:** Writing and contributing (`src/prompt-handlers`).
- **Framework Drivers:** Custom implementation, snapshot support, and type references.

### Showcase Page:
- Highlights Detox as the initial use case and invites collaboration with other frameworks.
    @LironMShemen
    LironMShemen committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    0e57f7b View commit details
    Browse the repository at this point in the history

  2. chore: Changes due to code review 

    **Docusaurus leftovers were deleted.
**The link to edit the page was updated.
**The URL for the website was updated.
    @LironMShemen
    LironMShemen committed Nov 26, 2024
    Configuration menu
    Copy the full SHA
    48665ea View commit details
    Browse the repository at this point in the history