Feel free to edit any page & to send us a Pull Request!!
Note: you can edit the pages on GitHub directly,
you don't even have to git clone the repository.
Just select the file on GitHub
and click the pencil/edit icon,
which will open the GitHub editor for the file.
Example for this page.
If you don't want to edit the page on GitHub, feel free to contact us, and we'll do the change for you!
tips-and-tricksvstutorials:tutorialshave to include a complete guide as much as possible, e.g. steps to register the repository/app.tips-and-tricksis short, only describes the thing it wants to achieve. Later can be moved intotutorial, by adding more info.
API responses and the whole .md files are auto-generated;
please edit the .md.gg template files instead of editing the .md directly!
To add a new endpoint documentation section:
- open the
docs/api/vX.md.ggtemplate file - add the endpoint section, following the other endpoints' doc structure
- add the example endpoint call to the
_scripts/gen_api_docs_gotgen_config.gofile (using theapi-demobitrise.io user to locate the right example URL, e.g. if it have to include a repo/build/... slug) - use that in the example response section of the endpoint (
{{ (var "/URL-PATH").HTTPMETHOD }}) - and finally, run:
bitrise run generate-api-docsto generate the.mdfrom the.md.gg