Skip to content

Feature/publishing - #11

Merged
mohdaquib merged 11 commits into
mainfrom
feature/publishing
Jul 14, 2026
Merged

Feature/publishing#11
mohdaquib merged 11 commits into
mainfrom
feature/publishing

Conversation

@mohdaquib

Copy link
Copy Markdown
Owner
  • Added a README file and uploaded the overlay recording GIF file
  • Added documentation using the Dokka library

mohdaquib added 11 commits July 10, 2026 16:20
- 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.
@mohdaquib
mohdaquib merged commit 4f75ba8 into main Jul 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant