Repository navigation
docs: document all 11 starters; add ARCHITECTURE.md and DEVELOPER.md - #2
Merged
Merged
Conversation
README: - Available Starters table now lists all eleven starters (was three), with descriptions, config prefixes, and versions. - Corrected Maven coordinates to the real group io.github.saumilp.starters (badge, Quick Start snippets). - Project Structure now reflects the .kts build files, every starter/example module, and the new docs. - Building Locally uses the dedicated integrationTest task; added a documentation index. New docs: - ARCHITECTURE.md — module topology and dependency graph, starter anatomy, auto-configuration registration and conditional strategy, observability, build/test architecture, CI/CD, and the Spring Boot 4.0 baseline. - DEVELOPER.md — prerequisites, Gradle commands, running integration tests, a step-by-step "add a new starter" guide, coding/testing conventions, Spring Boot 4.0 gotchas, publishing/release, and troubleshooting.
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
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.
README:
New docs:
Summary
Changes
Type of change
Checklist
./gradlew spotlessCheckpasses locally./gradlew javadoccompiles without warnings[Unreleased]