Add links to help direct AI bots to the guides

Author: rob-bygrave

docs/db-migrations/index.html

@@ -146,6 +146,12 @@ <h1 id="breadcrumb">
   </div>
 </form>
 
+
+<p>
+  <strong>AI agent / step-by-step guide:</strong>
+  <a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/add-ebean-db-migration-generation.md">Database migration generation</a>
+</p>
+
 <h2 id="db-migrations">DB Migrations</h2>
 <p>
   DB Migrations are DDL changes that are applied typically when the application is started.

docs/getting-started/ebean-test.html

@@ -96,6 +96,12 @@ <h1 id="breadcrumb">
   </div>
 </form>
 
+
+<p>
+  <strong>AI agent / step-by-step guide:</strong>
+  <a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/add-ebean-postgres-test-container.md">Test container setup (PostgreSQL / PostGIS via Docker)</a>
+</p>
+
 <h2>Test setup</h2>
 <p>
   <code>ebean-test</code> is used to setup and configure Ebean for running tests.

docs/getting-started/index.html

@@ -122,6 +122,23 @@ <h3 id="examples">Example projects</h3>
 
 <p>&nbsp</p>
 
+<h2 id="ai-guides">Step-by-step guides (for AI agents and developers)</h2>
+<p>
+  Prescriptive step-by-step guides for adding Ebean to an existing project are available
+  in the Ebean GitHub repository. These guides are written to be followed by AI coding
+  agents (Copilot, Cursor, Claude Code, etc.) as well as human developers.
+</p>
+<ul>
+  <li><a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/add-ebean-postgres-maven-pom.md">Add Ebean + PostgreSQL — Maven POM setup</a></li>
+  <li><a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/add-ebean-postgres-database-config.md">Database configuration (DataSourceBuilder + DatabaseBuilder)</a></li>
+  <li><a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/add-ebean-postgres-test-container.md">Test container setup (PostgreSQL / PostGIS via Docker)</a></li>
+  <li><a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/add-ebean-db-migration-generation.md">Database migration generation</a></li>
+  <li><a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/lombok-with-ebean-entity-beans.md">Using Lombok with Ebean entity beans</a></li>
+  <li><a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/README.md">Full guide index</a></li>
+</ul>
+
+<p>&nbsp</p>
+
 <h2 id="ide">Install IDE Plugin</h2>
 <p>
   Ebean uses bytecode enhancement to provide <code>dirty checking</code> and <code>lazy loading</code>.

docs/getting-started/maven.html

@@ -97,6 +97,11 @@ <h1 id="breadcrumb">
 </form>
 
 
+<p>
+  <strong>AI agent / step-by-step guide:</strong>
+  <a href="https://github.com/ebean-orm/ebean/blob/main/docs/guides/add-ebean-postgres-maven-pom.md">Add Ebean + PostgreSQL — Maven POM setup</a>
+</p>
+
 <h2 id="jdbc-dep">JDBC Driver(s)</h2>
 <p>
   Add the dependency for the JDBC Driver(s) you want to use.

llms.txt

@@ -33,6 +33,7 @@ Step-by-step instructions written for AI agents to add Ebean to an existing Mave
 - [Add Ebean + PostgreSQL — Step 2: Database configuration](https://raw.githubusercontent.com/ebean-orm/ebean/main/docs/guides/add-ebean-postgres-database-config.md): Configure the Ebean Database bean using DataSourceBuilder and DatabaseConfig with Avaje Inject. Covers minimal (master-only) and extended (master + read-only replica) setup. Includes verification steps and troubleshooting table.
 - [Add Ebean + PostgreSQL — Step 3: Test container setup](https://raw.githubusercontent.com/ebean-orm/ebean/main/docs/guides/add-ebean-postgres-test-container.md): Start a PostgreSQL or PostGIS Docker container for tests using ebean-test-containers and a @TestScope @Factory with Avaje Inject. Covers image mirror for CI/ECR, autoReadOnlyDataSource, dumpMetrics, PostGIS variant with optional LW/HexWKB mode, and keeping containers running locally.
 - [Lombok with Ebean entity beans](https://raw.githubusercontent.com/ebean-orm/ebean/main/docs/guides/lombok-with-ebean-entity-beans.md): Which Lombok annotations to use and avoid on entity beans. Explains why @Data is incompatible (hashCode/equals breaks entity identity, toString triggers lazy loading). Prescribes @Getter + @Setter + @Accessors(chain=true). Includes compatibility table for all common Lombok annotations.
+- [DB migration generation](https://raw.githubusercontent.com/ebean-orm/ebean/main/docs/guides/add-ebean-db-migration-generation.md): Add GenerateDbMigration.java to generate schema diff migrations offline (no database needed). Configure the migration runner with ebean.migration.run=true. Understand .sql and .model.xml output files. Covers version naming, multi-platform, pending drops, setPathToResources for multi-module projects, and named database support.
 
 ## Entities and Mapping