openproject/docs/api/README.md

API Documentation
-----------------

## API Version 3

_Status: under development_

The documentation for APIv3 is written in the [API Blueprint Format](http://apiblueprint.org/).

The generated APIv3 documentation is built regular on the `dev` branch and can be found at: [opf.github.io/apiv3-doc/](opf.github.io/apiv3-doc/).


You can also use [aglio](https://github.com/danielgtaylor/aglio) to generate HTML documentation locally, e.g. using the following command:

```bash
aglio -i apiv3-documentation.apib -o api.html
```
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip] 8 years ago			`API Documentation`
			`-----------------`

			`## API Version 3`

			`_Status: under development_`

			`The documentation for APIv3 is written in the [API Blueprint Format](http://apiblueprint.org/).`

			The generated APIv3 documentation is built regular on the `dev` branch and can be found at: [opf.github.io/apiv3-doc/](opf.github.io/apiv3-doc/).


			`You can also use [aglio](https://github.com/danielgtaylor/aglio) to generate HTML documentation locally, e.g. using the following command:`

			```bash
			`aglio -i apiv3-documentation.apib -o api.html`
			```