Now that getting started guides are separate documentation, some of the wording is a bit confusing because it lacks context. For example, the getting started guide for the ORM integration has the title:
Getting started with the Hibernate ORM integration
But… integration of what? It should be:
Getting started with Hibernate Search in Hibernate ORM
I suspect there are more places that lack context like this. We need to look for those and fix them. For example the first sentence in the guide:
This guide will walk you through the initial steps required to index and query your Hibernate ORM entities using Hibernate Search.
We should probably add a link to the reference documentation or the website on “Hibernate ORM” and “Hibernate Search”, since these are the first time in the document they are mentioned, and they weren’t introduced. |