Documentation website

[diego-aquino]

Prerequisites

• I confirm that none of the open issues match my proposal
• I confirm that my proposal is not yet available in the latest version of Zimic (see the documentation and the releases)

Scope

Adds a new behavior

Compatibility

• This is a breaking change

Context

Our current GitHub Wiki has been serving us well. However, there a few downsides to it:

• The content is not indexed by search engines unless the repository reaches 200 stars.
• It is not straightforward to differentiate between versions in the wiki. A custom website could allow selecting the major version such as socket.io.
• We cannot use tabs to switch between local and remote interceptors because the GitHub-flavored markdown does not supported tabs.
• As Zimic's API and patterns become bore established and stable, I believe we could improve the documentation with new or more organized content, as detailed in Extend documentation with common use cases #401. Create a migration guide from MSW #388. Create a migration guide from Nock #389. Create FAQ with common erors, problems and solutions #346. Create comparison page with other solutions #400. Create a migration guide from Cypress cy.intercept #473. Create a migration guide from Playwright page.route #474. and Create a migration guide from axios-mock-adapter #390.
• Having a documentation website and a domain contributes to the image of the library.
• Having a documentation website could also generate some revenue for the project by showing high-quality ads.

Feature description

Create a documentation website for Zimic.

Docusaurus seems like a great technology for that. It supports MDX, React, translations, and versioning, to name a few features.