This directory contains the documentation for the UMA as a Service (UMAaaS) API, built using Docusaurus and Redocusaurus for the OpenAPI specification.
- Node.js (v16 or higher)
- npm (v7 or higher)
- Install dependencies:
npm installTo start the development server:
npm startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
To build the documentation for production:
npm run buildThis command generates static content into the build directory and can be served using any static contents hosting service.
To serve the built documentation locally:
npm run servedocs/: Contains the Markdown documentation filesguides/: Contains guides for using the UMAaaS API
static/: Contains static filesapi/: Contains the OpenAPI specificationimg/: Contains images used in the documentation
src/: Contains React components and custom CSSdocusaurus.config.ts: Docusaurus configuration filesidebars.ts: Sidebar configuration file
The OpenAPI specification is located at static/api/openapi.yaml. This file is used by Redocusaurus to generate the API reference documentation.
To contribute to the documentation:
- Make your changes to the Markdown files in the
docs/directory or to the OpenAPI specification instatic/api/openapi.yaml. - Test your changes locally using
npm start. - Submit a pull request with your changes.
This documentation is licensed under the MIT License.