docs: fix broken links and code examples; publish Java Javadoc in CI#152
Merged
Conversation
- landing page: topCities generated SQL groups by u.city_id (the FK column
.groupBy(User_.city) actually emits), not the expanded city columns
- getting-started/index: replace broken absolute /dirty-checking and /ai
links with relative doc links (docs now served under /docs)
- relationships: use orm.get so the example reads user.city.name (the old
orm.find + user?.city.name did not compile)
- configuration: add {#schema-validation} anchor so the five
"Schema Validation" cross-references resolve
- faq: point deferred-loading link at refs.md#deferred-loading
(entities.md#deferred-loading-with-ref did not exist)
- docs.yml: copy aggregate Javadoc from target/site/apidocs (Maven 3) as
well as target/reports/apidocs (Maven 4) and fail loudly if absent, so
/api/java/index.html stops 404ing on orm.st
Doc fixes applied to docs/ and the latest versioned_docs snapshot only.
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.
Summary
Fixes several broken links and incorrect code examples across the docs and landing page, plus a CI bug that leaves the Java Javadoc unpublished on orm.st. Documentation changes are applied to
docs/and the latestversioned_docs/version-1.11.5snapshot only (older snapshots left frozen).Changes
src/pages/index.js) — thetopCitiesgenerated-SQL panel now showsGROUP BY u.city_idinstead of the expandedc.id, c.name, c.population, c.country. Verified against the framework:.groupBy(User_.city)on a single-column-PK@FKflattens to a single leaf and resolves to the foreign-key column on the driving table (same resolution asWHERE).getting-started.md/index.md— replaced broken absolute links/dirty-checkingand/aiwith relative doc links (docs are served under/docs, so root-absolute links 404).relationships.md— switched the many-to-one example toorm.getso it readsuser.city.name. The previousorm.find+user?.city.namedid not compile (safe-call chain on a nullable receiver).configuration.md— added an explicit{#schema-validation}anchor to thestorm.validation.schema_modeheading so the five "Schema Validation" cross-references (spring-integration, faq ×2, entities, migration-from-jpa) resolve.faq.md— retargeted the deferred-loading link torefs.md#deferred-loading;entities.md#deferred-loading-with-refdid not exist..github/workflows/docs.yml— the "Copy Javadoc" step guarded ontarget/reports/apidocs(Maven 4), butmvn javadoc:aggregateon the Maven 3.9.x runner writes totarget/site/apidocs, so the copy silently no-opped and an emptystatic/api/javashipped. Now copies from either path and fails loudly if neither exists.Verification
GROUP BY u.city_idbehavior (testGroupByInlineRecordasserts the FK leaf resolves tocity_id).docs/andversion-1.11.5— all in-content links now resolve./api/java/index.htmlreturns 404, all five/api/kotlin/<module>/index.htmlreturn 200. The workflow fix addresses the Java 404 on the next docs deploy.