Draft doc structure #239
Draft doc structure #239
Conversation
There was a problem hiding this comment.
Pull request overview
This PR restructures documentation and updates dependencies across the project. The changes include creating a new documentation structure with comprehensive guides, updating Gradle wrapper to 9.2.1, upgrading various dependencies (Protobuf, Kotlin, JUnit, etc.), and refactoring build configuration to use the new io.spine.generated-sources plugin and updated Dokka setup.
Key Changes
- Documentation restructured into a comprehensive multi-section guide with Table of Contents
- Gradle wrapper upgraded from 9.1.0 to 9.2.1
- Major dependency updates (Kotlin 2.2.21, Protobuf 4.33.1, JUnit 6.0.0, etc.)
- Build configuration refactored to use new Dokka 2.1.0 setup and
io.spine.generated-sourcesplugin
Reviewed changes
Copilot reviewed 67 out of 71 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
docs/ToC.md |
New comprehensive documentation table of contents structure |
docs/00-intro/*.md |
New introduction section with overview, target audience, and philosophy |
docs/01-getting-started/index.md |
New getting started guide |
docs/developers-guide/*.md |
New developer-focused documentation on architecture and modules |
docs/adding-custom-validataion.md |
New guide for adding custom validation |
gradle/wrapper/gradle-wrapper.properties |
Gradle version bump to 9.2.1 |
buildSrc/src/main/kotlin/io/spine/dependency/**/*.kt |
Dependency version updates and refactoring |
buildSrc/src/main/kotlin/**/*.gradle.kts |
Build script updates for new Dokka and plugin configuration |
java-runtime/build.gradle.kts |
Migration to io.spine.generated-sources plugin |
| Various buildSrc files | Removal of deprecated code and simplification of publishing configuration |
Comments suppressed due to low confidence (2)
docs/adding-custom-validataion.md:1
- Corrected spelling of 'validataion' to 'validation' in the filename.
buildSrc/src/main/kotlin/io/spine/gradle/repo/RepoSlug.kt:1 - The SSH host alias changed from
github.com-publishtogithub-publish, but this may break existing SSH configurations. Ensure the corresponding SSH config inSshKey.kt(lines 113-116) is consistently used everywhere, and verify that CI/CD systems have been updated to match this change.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "The dependency `${this::class.simpleName}` does not declare a module `$module`." | ||
| ) | ||
| } else { | ||
| "$module:$version" |
There was a problem hiding this comment.
When version parameter is provided, the method returns $module:$version without prepending the group. This creates an incomplete Maven coordinate. Should be $group:$module:$version or the artifacts map should already contain full coordinates.
| "$module:$version" | |
| "$group:$module:$version" |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 67 out of 71 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (3)
docs/adding-custom-validataion.md:1
- Corrected spelling of 'validataion' to 'validation' in filename.
gradlew:1 - The copyright year range was changed from '2015-2021' to just '2015'. If this is intentional to reflect the last modification year, it should be '2015-2025' to include the current year. Otherwise, the previous range '2015-2021' was more accurate.
buildSrc/src/main/kotlin/io/spine/gradle/git/Repository.kt:1 - Using
logger.error()for informational command execution messages is incorrect. This should uselogger.debug()orlogger.info()as these are diagnostic messages, not errors.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "The dependency `${this::class.simpleName}` does not declare a module `$module`." | ||
| ) | ||
| } else { | ||
| "$module:$version" |
There was a problem hiding this comment.
The artifact notation is malformed. It should be $group:$module:$version but this returns only $module:$version, missing the group ID.
No description provided.