ci: add Dokka for kdoc documentation generation and deployment (#3024)

Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
This commit is contained in:
James Rich 2025-09-08 18:31:53 -05:00 committed by GitHub
parent bd29d0c55c
commit e490b036be
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 90 additions and 0 deletions

View file

@ -38,6 +38,23 @@ width="24%">](https://play.google.com/store/apps/details?id=com.geeksville.mesh&
The play store is the last to update of these options, but if you want to join the Play Store testing program go to [this URL](https://play.google.com/apps/testing/com.geeksville.mesh) and opt-in to become a tester.
If you encounter any problems or have questions, [ask us on the discord](https://discord.gg/meshtastic), [create an issue](https://github.com/meshtastic/Meshtastic-Android/issues), or [post in the forum](https://github.com/orgs/meshtastic/discussions) and we'll help as we can.
## Documentation
The project's documentation is generated with [Dokka](https://kotlinlang.org/docs/dokka-introduction.html) and hosted on GitHub Pages. It is automatically updated on every push to the `main` branch.
[**View Documentation**](https://meshtastic.github.io/Meshtastic-Android/)
### Generating Locally
You can generate the documentation locally to preview your changes.
1. **Run the Dokka task:**
```bash
./gradlew :app:dokkaHtml
```
2. **View the output:**
The generated HTML files will be located in the `app/build/dokka/html` directory. You can open the `index.html` file in your browser to view the documentation.
## Translations
You can help translate the app into your native language using [Crowdin](https://crowdin.meshtastic.org/android).