NOTE: This assumes that the parent directory of lorawan-stack-docs also contains lorawan-stack. If not, you'll need to adjust the commands accordingly.
[ ] To generate and export CLI documentation from within the clone of TheThingsIndustries/lorawan-stack, first run the following command to build the CLI:
$ go build -tags tti ./cmd/tti-lw-cli
[ ] Then export the CLI documentation using the following command:
[ ] A new section has been created in whats-new with the corresponding CHANGELOG from TheThingsIndustries/lorawan-stack. The title is the release version and the date is the release date.
[ ] The documentation version is up to date.
[ ] The TTI and TTN API documentation has been generated and updated in doc/data/api. This includes the following files:
Overview
This is a checklist for releases. This is filled in by both the releaser and the reviewer where necessary.
Update Documentation
whats-new
section and copy the release CHANGELOG from TheThingsIndustries/lorawan-stack. The title is the release version and the date is the release date.v3.${minor}
).lorawan-stack-docs
by running the following commands inlorawan-stack-docs
:Check (for reviewers)
whats-new
with the corresponding CHANGELOG from TheThingsIndustries/lorawan-stack. The title is the release version and the date is the release date.