This directory contains the documentation for Evalap, built with Docusaurus.
- Node.js (version 16.14 or above)
- npm or yarn
# Navigate to the docs directory
cd docs
# Install dependencies
npm install
# or if you use yarn
yarn install# Start the development server
npm start
# or if you use yarn
yarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
# Build the documentation
npm run build
# or if you use yarn
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
The documentation is organized into the following sections:
- Getting Started: Installation and setup guides
- User Guides: Guides for using Evalap features
- Developer Guide: Information for developers extending Evalap
- API Reference: Detailed API documentation
Contributions to improve the documentation are welcome! Please follow these steps:
- Fork the repository
- Create a new branch for your changes
- Make your changes to the documentation
- Submit a pull request
Please ensure your documentation changes are clear, concise, and follow the existing style.
MIT