docs: fix quick start Maven coordinates - #52
Conversation
📝 WalkthroughWalkthroughThe README's "Add the dependency" Gradle snippets are corrected: the Maven group is changed from ChangesREADME Maven Coordinates Fix
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related issues
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 45-47: The markdown file does not comply with MD031 by missing
blank lines around the code fence. Add a blank line before the "Gradle kts:"
text and another blank line between "Gradle kts:" and the opening code fence
(```kotlin) to ensure proper spacing between text and fenced code blocks as
required by markdown linting standards.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ``` | ||
| Gradle kts: | ||
| ```kotlin |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial | ⚡ Quick win
Add blank lines around code fences to comply with MD031.
Markdown best practice requires blank lines between text and fenced code blocks for readability and linting compliance.
📝 Proposed fix to add blank lines
annotationProcessor("io.github.eventhorizonlab:spi-tooling-processor:<version>")
}Gradle kts:
+
dependencies {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ``` | |
| Gradle kts: | |
| ```kotlin |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 45-45: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 47-47: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 45 - 47, The markdown file does not comply with MD031
by missing blank lines around the code fence. Add a blank line before the
"Gradle kts:" text and another blank line between "Gradle kts:" and the opening
code fence (```kotlin) to ensure proper spacing between text and fenced code
blocks as required by markdown linting standards.
Source: Linters/SAST tools
1 participant
Summary
io.github.eventhorizonlab.spi-tooling-processorfor the GroovyannotationProcessorexample, matching the published processor artifact.Related Issue
Validation
gradle.properties:group=io.github.eventhorizonlab.build.gradle: Maven publishing coordinates userootProject.groupand${rootProject.name}-${project.name}.settings.gradle: published subprojects areannotationsandprocessor.0.1.23POM/JAR URLs for:io.github.eventhorizonlab:spi-tooling-annotationsio.github.eventhorizonlab:spi-tooling-processorcom.github.eventhorizonlab:*andio.github.eventhorizonlab:spi-tooling.git diff --check.I also tried a minimal Gradle dependency-resolution project with the corrected coordinates, but this local host has no Java runtime installed, so Gradle could not start.
Summary by CodeRabbit