Skip to content

Latest commit

 

History

History
 
 

README.md

Evalap Documentation

This directory contains the documentation for Evalap, built with Docusaurus.

Getting Started

Prerequisites

  • Node.js (version 16.14 or above)
  • npm or yarn

Installation

# Navigate to the docs directory
cd docs

# Install dependencies
npm install
# or if you use yarn
yarn install

Local Development

# Start the development server
npm start
# or if you use yarn
yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

# Build the documentation
npm run build
# or if you use yarn
yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Documentation Structure

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

Contributing to the Documentation

Contributions to improve the documentation are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes to the documentation
  4. Submit a pull request

Please ensure your documentation changes are clear, concise, and follow the existing style.

License

MIT