Repository navigation
docs: 60-second quickstart up top, and fix two copy-paste blockers - #31
Merged
Merged
Conversation
The README led with philosophy; the first runnable instruction was ~70 lines down, behind a 7-step walkthrough. Adds a verified 3-file quickstart directly under the title so the first thing a visitor sees is a green test. Two real defects found while writing it, both of which broke copy-paste: - The documented "minimum" selenium-boot.yml omitted the timeouts block. ConfigurationLoader validates timeouts.explicit and timeouts.pageLoad as positive ints (primitives, so absent = 0), and aborts the suite with "Selenium Boot failed to initialize". Verified: the old snippet exits 1. - The pom.xml snippet pinned no maven-compiler-plugin. On Maven <=3.8.x the compiler level falls back to source/target 5 and the build fails with "Source option 5 is no longer supported" on any modern JDK. This is the same defect already fixed in the IntelliJ wizard's ProjectScaffold. Also corrects the claim that selenium-boot.yml is optional (the loader throws if it is missing) in both the README and CLAUDE.md, and repoints the docs link from the stale seleniumboot.github.io URL to docs.seleniumboot.com. Verified end-to-end on Maven 3.8.7 + JDK 25 against Central 3.2.0 and real headless Chrome: 1 test, passed, exit 0. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Why
The README led with positioning and philosophy; the first runnable instruction sat ~70 lines down, behind a 7-step walkthrough. This puts a verified 3-file quickstart directly under the title.
Two real defects, both found while writing it
Both broke copy-paste for a first-time user.
1. The documented "minimum"
selenium-boot.ymldoes not work. It omitted thetimeoutsblock.ConfigurationLoader.validate()requirestimeouts.explicitandtimeouts.pageLoadto be positive — and they're primitiveints, so absent means0. Copy-pasting the old snippet aborts the suite:2. The
pom.xmlsnippet pinned nomaven-compiler-plugin. On Maven ≤3.8.x the compiler level falls back to source/target 5 and the build dies with "Source option 5 is no longer supported" on any modern JDK. This is the same defect already fixed in the IntelliJ wizard'sProjectScaffold— it was never fixed in the README.Also
selenium-boot.ymlis optional — the loader throws if it's missing — in both the README andCLAUDE.md.seleniumboot.github.ioURL todocs.seleniumboot.com.Verification
Scaffolded the quickstart exactly as documented and ran it clean-room on Maven 3.8.7 + JDK 25, resolving
3.2.0from Maven Central against real headless Chrome:Exit 0. The old minimum config was also run to confirm it genuinely fails (exit 1).
🤖 Generated with Claude Code