chore: add dokka plugin for documentation generation and versioning #104
Conversation
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
OmarAlJarrah
changed the base branch from
feature/new-sdk-core
to
v2/initial-github-actions
OmarAlJarrah
changed the base branch from
v2/initial-github-actions
to
feature/new-sdk-core
dtayeh
approved these changes
Apr 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Situation
The current build configuration for the XAP SDK does not include documentation generation capabilities, which limits the accessibility and usability of the SDK for developers.
Task
The objective is to integrate the Dokka documentation tool into the build process of the XAP SDK.
Action
org.jetbrains.dokkaplugin to thebuild.gradle.ktsfile.gradle.propertiesfile to enable experimental Dokka plugin mode.Testing
The changes were validated by running the build process and verifying that the documentation was generated successfully. The documentation was checked for correctness, inclusion of custom assets, and proper versioning. The build process was also tested to ensure that it completes without errors.
Results
The integration of Dokka into the build process has successfully enabled automated documentation generation for the XAP SDK. This improvement provides developers with easily accessible and versioned documentation, enhancing their ability to use the SDK. The build process remains stable with the new changes.
Notes