The user manual / documentation of OpenQDA

Deploy VitePress site to Pages GitHub License Project Status: Active – The project has reached a stable, usable state and is being actively developed. This is a research software documentation DOI

The documentation is available under https://openqda.github.io/user-docs/

It's built using vitepress, a modern static website generator for documentations.

$ npm install

$ npm run docs:dev

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

$ npm run docs:build
$ npm run docs:preview # optional to locally peview your build output

We use GitHub actions to automatically deploy updates to GitHub pages. Any merges to main will trigger a new build to be deployed. Pull requests, however will not trigger builds.

We welcome your contribution and appreciate your support! Please read our contribution guidelines in order to make your contribution a success.

See license file