Danny 97113aa80b
Folder Granularity scope Added to Collections Retrieval (#482)
Backup function `DataExchangeCollections` supports the ability to backup a single file using the `selectors` package. Support files and documentation updated accordingly
2022-08-05 11:20:36 -04:00
..
2022-05-18 14:22:38 -07:00
2022-05-19 13:32:03 -07:00
2022-05-16 22:44:49 -07:00
2022-05-24 12:39:08 -07:00
2022-05-24 12:39:08 -07:00

Corso documentation

Corso documentation uses Docusaurus 2, a modern static website generator. Mermaid provides support for native diagrams in Markdown.

Requirements

Developing documentation for Corso requires the following tools on your machine:

  • make
  • Docker

Installation

make buildimage

Live documentation development

make dev

This command starts a local development server within the Docker container and will expose docs at http://localhost:3000.

Building static documentation

make build

This command generates static content into the build directory for integration with any static contents hosting service.

Style and linting

make check

This command will lint all Markdown files and check them for style issues.

Documentation platform development

make shell

Use this command to interactively (and temporarily!) change the contents or configuration of the live documentation container image (for example, when experimenting with new plugins).