refactor(build): centralize Dokka documentation generation#4171
Merged
jamesarich merged 2 commits intomainfrom Jan 9, 2026
Merged
refactor(build): centralize Dokka documentation generation#4171jamesarich merged 2 commits intomainfrom
jamesarich merged 2 commits intomainfrom
Conversation
This commit centralizes the Dokka configuration at the root level of the project, removing the previous app-specific setup. This change simplifies documentation generation by applying a unified configuration across all modules. Key changes: - Moved Dokka configuration from `app/build.gradle.kts` to the root `build.gradle.kts`. - Applied the Dokka plugin to all subprojects and added them as dependencies to the root Dokka task for aggregation. - Configured `sourceLink` for all modules to correctly point to their source files on GitHub. - Suppressed generated code, including Hilt and string resource classes, from the documentation. - Updated the `docs.yml` workflow to use the new root-level Dokka task. - Removed `meshServiceExample` from Kover's coverage report. Signed-off-by: James Rich <2199651+jamesarich@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4171 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 2 2
Lines 19 19
Branches 7 7
=====================================
Misses 19 19 ☔ View full report in Codecov by Sentry. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit centralizes the Dokka configuration at the root level of the project, removing the previous app-specific setup. This change simplifies documentation generation by applying a unified configuration across all modules.
Key changes:
app/build.gradle.ktsto the rootbuild.gradle.kts.sourceLinkfor all modules to correctly point to their source files on GitHub.docs.ymlworkflow to use the new root-level Dokka task.meshServiceExamplefrom Kover's coverage report.resolves #4162 🤞