Skip to content

Commit 8f97618

Browse files
authored
docs: Add serialization-based schema generation docs (#197)
- Added documentation for runtime JSON schema generation using `@Serializable` classes. - Included a new link to "Serialization-Based Schema Generation" in README. - Updated docs Gradle configuration - Enhanced Makefile and AGENTS.md with updated Knit commands and instructions. ### Pre-Submission Checklist - [ ] **Self-reviewed** my own code - [ ] **Tests added/updated** and passing locally - [x] **Documentation updated** (if needed: README, code comments, etc.) - [ ] **Focused PR**: Single concern, no unrelated changes or "drive-by" fixes - [ ] **Breaking changes documented** (if applicable) - [ ] **No debug code**: Removed commented-out code and debug statements --- ## Reviewer Guidelines ### What should reviewers focus on? <!-- Optional: Highlight specific areas needing extra attention --> ### Review Philosophy Following Google's principle: **Approve if this PR improves the codebase**, even if it's not perfect. - [The Standard of Code Review](https://github.com/google/eng-practices/blob/master/review/reviewer/standard.md) - [What to look for](https://github.com/google/eng-practices/blob/master/review/reviewer/looking-for.md) **For Reviewers:** - [ ] Does this improve the codebase overall? - [ ] Are there any critical issues that block approval? - [ ] Can remaining improvements be addressed in follow-up PRs? --- ## Additional Notes Explains Question #193
1 parent 64a6cf8 commit 8f97618

File tree

6 files changed

+601
-104
lines changed

6 files changed

+601
-104
lines changed

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,7 @@ Each module must have a `Module.md` file at the module root for Dokka-generated
208208
- Build all modules: `./gradlew build`
209209
- Run all tests: `./gradlew test`
210210
- KSP integration tests: `make integration-test`
211+
- Verify knit examples compile: `make knit`
211212

212213
## When to ask for help
213214

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,14 @@ scan:
2727
apidocs:
2828
@echo "📚 Generating API documentation..."
2929
@rm -rf docs/public/apidocs && \
30-
./gradlew clean :docs:dokkaGenerate
30+
@./gradlew clean :docs:dokkaGenerate
3131
@echo "✅ API docs generated!"
3232

3333
.PHONY: knit
3434
knit:
3535
@echo "🪡🧶 Running Knit check ..."
36-
./gradlew :docs:clean knit knitCheck :docs:testClasses --no-configuration-cache
36+
@./gradlew :docs:clean knit knitCheck :docs:test --no-configuration-cache
37+
@./gradlew :docs:test
3738
@echo "✅ Knit check completed!"
3839

3940
.PHONY: clean

0 commit comments

Comments
 (0)