Good documentation is just as important as good code. CIDER is a pretty complex project with numerous features and the user manual is one of the primary ways to discover those. Please, consider improving and extending it.
|The instructions here assume you already have (the right version of) node.js installed.|
Installing the Antora is super simple:
$ npm i -g @firstname.lastname@example.org @email@example.com
Check out the detailed installation instructions if you run into any problems.
If you want to make changes to the manual’s page structure you’ll have to edit nav.adoc.
To make changes to the manual you simply have to change the files under
You can build the documentation locally from the docs.cider.mx repo.
$ cd docs.cider.mx $ antora antora-playbook.yml
|The manual will be regenerated manually periodically by CIDER’s Core Team.|
We’re currently publishing the user manual to GitHub Pages. The deployment process is simply pushing the generated HTML to GitHub. Simple as that. There’s a simple script in the documentation repository that automates the process of fetching the latest updates and publishing them:
$ cd docs.cider.mx $ ./deploy
Don’t forget to update the manual’s version metadata when cutting CIDER releases.
It lives in
Down the road we plan to automate the process and deploy automatically changes to the manual. Ideally this should be done by our CI.