Feature/publishing - #11
Merged
Merged
Conversation
mohdaquib
commented
Jul 14, 2026
mohdaquib
commented
Owner
- Added a README file and uploaded the overlay recording GIF file
- Added documentation using the Dokka library
- Add Dokka plugin and dependency for documentation generation. - Implement Maven Publish configuration in the root `build.gradle.kts` for `scanner-core`, `scanner-rules`, and `scanner-ui`. - Configure automated versioning and Javadoc JAR generation using Dokka. - Add ProGuard keep rules to `consumer-rules.pro` for all three library modules to prevent obfuscation of public classes.
- Add comprehensive KDoc comments to public classes and methods across `scanner-core`, `scanner-rules`, and `scanner-ui` modules. - Include documentation for key models such as `A11yNode`, `A11yIssue`, `ScanResult`, and `ScannerConfig`. - Document scanner rules including `TouchTargetRule`, `TextScalingRule`, and `FocusOrderRule`. - Add documentation for UI components and extensions like `A11yScannerScaffold` and `scanOnShake`. - Apply Dokka plugin to the root project and configure documentation dependencies for all subprojects. - Add a GitHub Actions workflow to automatically generate and publish Dokka HTML documentation to GitHub Pages on pushes to the main branch.
- Add comprehensive KDoc comments to public classes and methods across `scanner-core`, `scanner-rules`, and `scanner-ui` modules. - Include documentation for key models such as `A11yNode`, `A11yIssue`, `ScanResult`, and `ScannerConfig`. - Document scanner rules including `TouchTargetRule`, `TextScalingRule`, and `FocusOrderRule`. - Add documentation for UI components and extensions like `A11yScannerScaffold` and `scanOnShake`. - Apply Dokka plugin to the root project and configure documentation dependencies for all subprojects. - Add a GitHub Actions workflow to automatically generate and publish Dokka HTML documentation to GitHub Pages on pushes to the main branch.
- Provide project overview and architecture for Compose A11y Scanner. - Add installation and integration guides, including usage of `A11yScannerScaffold` and `scanOnShake`. - Document built-in accessibility rules and instructions for implementing custom rules. - Include a demo GIF illustrating the scanner overlay and issue reporting.
- Add Dokka plugin and dependency for documentation generation. - Implement Maven Publish configuration in the root `build.gradle.kts` for `scanner-core`, `scanner-rules`, and `scanner-ui`. - Configure automated versioning and Javadoc JAR generation using Dokka. - Add ProGuard keep rules to `consumer-rules.pro` for all three library modules to prevent obfuscation of public classes.
- Add comprehensive KDoc comments to public classes and methods across `scanner-core`, `scanner-rules`, and `scanner-ui` modules. - Include documentation for key models such as `A11yNode`, `A11yIssue`, `ScanResult`, and `ScannerConfig`. - Document scanner rules including `TouchTargetRule`, `TextScalingRule`, and `FocusOrderRule`. - Add documentation for UI components and extensions like `A11yScannerScaffold` and `scanOnShake`. - Apply Dokka plugin to the root project and configure documentation dependencies for all subprojects. - Add a GitHub Actions workflow to automatically generate and publish Dokka HTML documentation to GitHub Pages on pushes to the main branch.
- Add comprehensive KDoc comments to public classes and methods across `scanner-core`, `scanner-rules`, and `scanner-ui` modules. - Include documentation for key models such as `A11yNode`, `A11yIssue`, `ScanResult`, and `ScannerConfig`. - Document scanner rules including `TouchTargetRule`, `TextScalingRule`, and `FocusOrderRule`. - Add documentation for UI components and extensions like `A11yScannerScaffold` and `scanOnShake`. - Apply Dokka plugin to the root project and configure documentation dependencies for all subprojects. - Add a GitHub Actions workflow to automatically generate and publish Dokka HTML documentation to GitHub Pages on pushes to the main branch.
- Provide project overview and architecture for Compose A11y Scanner. - Add installation and integration guides, including usage of `A11yScannerScaffold` and `scanOnShake`. - Document built-in accessibility rules and instructions for implementing custom rules. - Include a demo GIF illustrating the scanner overlay and issue reporting.
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.