Goal
The GitHub repository homepage field is currently empty. Setting it improves discoverability (it's shown prominently on the repo, and a real titled site earns its own Google ranking and gives us backlink surface). But what to point it at needs a deliberate decision — hence a dedicated issue.
Options for what the homepage should be
Option A — Published Javadoc site
Point the homepage at hosted API docs (e.g. GitHub Pages built from mvn javadoc:javadoc, or a javadoc.io URL once published to Maven Central: https://javadoc.io/doc/io.github.java-helpers/simple-builders-core).
- Pros: zero/low authoring effort, always accurate, useful reference for
@SimpleBuilder, @SimpleBuilder.Options, generated APIs. javadoc.io works automatically for anything on Maven Central.
- Cons: Javadoc is a reference, not a landing page — poor first impression for a newcomer evaluating the library; weak for SEO/marketing copy.
Option B — A proper docs / landing website (GitHub Pages)
A small site (GitHub Pages from docs/, or a generator like Docusaurus/MkDocs/Antora) with a landing page + guides.
- Pros: best for first impressions, SEO, and onboarding; can host the getting-started, configuration guide (we already have
docs/CONFIGURATION.md), comparison vs Lombok/RecordBuilder, and examples; controllable <title>/meta for Google.
- Cons: authoring + maintenance effort; needs a theme and content.
Option C — Hybrid (recommended starting point)
Landing/docs site (Option B) that links out to the Javadoc (Option A). Homepage → docs site; docs site prominently links the API reference.
What to put on it (if we go with B/C)
- One-paragraph pitch (reuse the new README tagline).
- Getting started (install snippet).
- Feature tour (records, Jackson,
with/copy, conditional, collections).
- Configuration reference (port/link
docs/CONFIGURATION.md).
- Comparison vs Lombok / Immutables / AutoValue / FreeBuilder / RecordBuilder.
- Link to Javadoc + Maven Central + GitHub.
Decision needed
- A, B, or C?
- If B/C: which generator (plain GitHub Pages / MkDocs / Docusaurus / Antora)?
- Hosting path (GitHub Pages on
java-helpers.github.io/simple-builders vs a custom domain)?
Once decided, a follow-up PR can scaffold the site and set the homepage field.
Goal
The GitHub repository homepage field is currently empty. Setting it improves discoverability (it's shown prominently on the repo, and a real titled site earns its own Google ranking and gives us backlink surface). But what to point it at needs a deliberate decision — hence a dedicated issue.
Options for what the homepage should be
Option A — Published Javadoc site
Point the homepage at hosted API docs (e.g. GitHub Pages built from
mvn javadoc:javadoc, or a javadoc.io URL once published to Maven Central:https://javadoc.io/doc/io.github.java-helpers/simple-builders-core).@SimpleBuilder,@SimpleBuilder.Options, generated APIs. javadoc.io works automatically for anything on Maven Central.Option B — A proper docs / landing website (GitHub Pages)
A small site (GitHub Pages from
docs/, or a generator like Docusaurus/MkDocs/Antora) with a landing page + guides.docs/CONFIGURATION.md), comparison vs Lombok/RecordBuilder, and examples; controllable<title>/meta for Google.Option C — Hybrid (recommended starting point)
Landing/docs site (Option B) that links out to the Javadoc (Option A). Homepage → docs site; docs site prominently links the API reference.
What to put on it (if we go with B/C)
with/copy, conditional, collections).docs/CONFIGURATION.md).Decision needed
java-helpers.github.io/simple-buildersvs a custom domain)?Once decided, a follow-up PR can scaffold the site and set the homepage field.