- Create GitHub access token; check
public_repo
onSelect scopes
section. - Use the token value as a value for github workflow with the name
secrets.GITHUB_TOKEN
- Make a test commit to trigger CI:
git commit --allow-empty -m "Test CI" && git push
- Wait until build is finished. You can check progress by clicking on the
Build Status
badge at the top - If you did everything correct, https://mibexsoftware.github.io/create-branch-wizard-rest-api/ will lead to your new docs
- [Optional] You can setup custom domain (just create
web/CNAME
file) - Start writing/editing your OpenAPI spec: check out section below
- Documentation(ReDoc): https://mibexsoftware.github.io/create-branch-wizard-rest-api/
- Start a simple http server that watches your files e.g.
npx browser-sync start --server --files "*.html, *.json"
- Make changes using your favorite editor or
swagger-editor
(look for URL in console output) - All changes are immediately propagated to your local server, moreover all documentation pages will be automagically refreshed in a browser after each change
TIP: you can open
swagger-editor
, documentation andswagger-ui
in parallel TIP: use the redocly extension in VSCode, nice autocompletion and preview functions