Skip to content

docs: document all 11 starters; add ARCHITECTURE.md and DEVELOPER.md - #2

Merged
SaumilP merged 1 commit into
mainfrom
feature/documentation-updates
Jul 5, 2026
Merged

SaumilP merged 1 commit into
mainfrom
feature/documentation-updates

Conversation

@SaumilP

@SaumilP SaumilP commented Jul 5, 2026

Copy link
Copy Markdown
Owner

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.

Summary

Changes

  • README.md updates

Type of change

  • Bug fix
  • New feature / starter
  • Breaking change
  • Documentation update
  • Dependency update

Checklist

  • Unit tests added or updated
  • Integration tests added (if touching infrastructure adapters)
  • JavaDoc added for all new public methods
  • ./gradlew spotlessCheck passes locally
  • ./gradlew javadoc compiles without warnings
  • README updated (if adding new configuration properties or starter)
  • CHANGELOG.md entry added under [Unreleased]

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.
@SaumilP SaumilP self-assigned this Jul 5, 2026
@SaumilP
SaumilP merged commit 426f933 into main Jul 5, 2026
4 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