Docs/ci example

[kevinccbsg]

This pull request introduces several significant updates to the TWD documentation and configuration. The most notable changes include the addition of a GitHub Actions workflow for deploying documentation, substantial improvements and clarifications to the API mocking documentation, a reorganization of the documentation navigation to focus on a tutorial format, and expanded API documentation for new utilities such as the Vite plugin and CI integration. These updates aim to make the documentation more user-friendly, accurate, and comprehensive.

Documentation Deployment:

• Added a new GitHub Actions workflow .github/workflows/deploy_docs.yml to automate building and deploying the VitePress documentation site to GitHub Pages.

API Mocking Documentation Improvements:

• Updated docs/api-mocking.md to clarify setup steps, improve code samples (using await consistently with twd.visit()), correct request body assertions, and add best practice examples for mocking requests before navigation. Removed outdated or redundant sections and improved explanations of common patterns. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]

Navigation and Tutorial Reorganization:

• Changed navigation in docs/.vitepress/config.mts to replace the "Examples" section with a more comprehensive "Tutorial," updating both the nav bar and sidebar structure to reflect this focus. [1] [2]

API Reference Expansion:

• Enhanced docs/api/index.md to document additional test functions (it.only, it.skip, afterEach), and added sections for new utilities:
  • Vite Plugin: Documented removeMockServiceWorker() for production build cleanup.
  • CI Integration: Documented reportResults() for formatted test reporting.
  • Improved clarity on best practices, debugging, and removed redundant error handling examples. [1] [2] [3] [4] [5] [6] [7]

Other Notable Updates:

• Minor corrections to paginated results examples in docs/api-mocking.md for accuracy. [1] [2] [3]
• Removed redundant error handling code samples from docs/api/twd-commands.md for brevity and clarity.

These changes collectively improve the usability, accuracy, and maintainability of the TWD documentation and deployment process.

This PR closes #47 it does not add full tutorials but add vitepress docs