cogment official website & documentation

Cogment is an innovative open source AI platform designed to leverage the advent of AI to benefit humankind through human-AI collaboration developed by AI Redefined. Cogment enables AI researchers and engineers to build, train and operate AI agents in simulated or real environments shared with humans. For the full user documentation visit https://cogment.ai

This is the sources for the official website and for the documentation for the Cogment framework.

Documentation architecture

This website is built using Docusaurus 2, the styling framework is infima:

docusaurus.config.js is the main configuration file for the documentation.
./docs contains the source for the documentation, mostly markdown file and images.
./src contains the source for the other pages.

Developers

Prerequisites

Have a working setup for Node 16 or above.
In this directory, run npm install to install what's needed to build the doc.

Running a self reloading server

npm run 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

npm run build

Formatting

This project is formatted using prettier. Most editors have support for it. The only requirement is a working Node.js environment. For further information, refer to https://prettier.io.

To run a check manually:

npm run lint

To fix all the files automatically

npm run task lint_fix