Boomerang documentation repository

This repository contains the documentation Markdown source files for useboomerang/docs.

The main branch will be automatically accessible along with any releases.

Releases

Releases are tagged with the version number matching a release and prefixed with the product. For example [email protected] or [email protected].

Design

Markdown metadata is used to generate the documentation site: table of contents, breadcrumbs, and other navigation elements.

This is based on the Remix Docs Template and its content requirements.

Contributing

Please see the CONTRIBUTING.md file for more information on how to contribute to this repository.

Generating the API docs

To update the API docs, run the following commands along with the API spec (currently stored in flow/apis/assets/spec.json):

npx openapi-generator-cli generate -i ./flow/apis/assets/spec.json -g markdown -o ./tmp --skip-validate-spec -t ./flow/apis/assets/templates/ --api-name-suffix 'Route'
mv ./tmp/README.md ./tmp/overview.md
find ./tmp/Apis -type f -exec mv {} ./tmp/ \;
find ./tmp/*.md -type f -exec mv {} ./flow/apis/ \;
find ./tmp/Models/*.md -type f -exec mv {} ./flow/apis/models/ \;
rm -rf ./tmp

Pre-req

npm install @openapitools/openapi-generator-cli -g

References

• The available mustahe variables can be found here
• Available mustache lambdas can be found here

Tips

When writing the Java code, make sure to add the summary and description for each method, they are key to the generated API documentation.

To Do

• Add a script to automatically generate the API docs and update the flow/apis/docs folder.
• Implement an MDX version so that the {{requestBodyExamples}} can be added within a code block element. Future reference

License

This repository is licensed under the Apache License, Version 2.0.