Skip to content

docs(readme): slim README to a start guide; fix stale config claims - #144

Merged
shossain786 merged 5 commits into
masterfrom
docs/readme-slim
Oct 10, 2026
Merged

shossain786 merged 5 commits into
masterfrom
docs/readme-slim

Conversation

@shossain786

Copy link
Copy Markdown
Contributor

What & why

README had grown to 851 lines and contradicted itself on whether selenium-boot.yml is required.

  • Slim README to a start guide (~325 lines): Quickstart, comparison, overview, page object + test, short config block, Learn More table.
  • Reference sections moved out; every one already has a docs-site page, linked from the table.
  • Fix: README claimed the YAML is required. It is optional (ConfigurationLoader, Quickstart, CLAUDE.md).
  • Fix: README documented -Denv=staging for profiles; the real property is -Dselenium.boot.profile (-Denv is test data only).
  • Fix: Documentation link pointed at the old GitHub Pages URL.
  • docs/ci/github-actions.md: the Headless section used browser.type and SELENIUM_HEADLESS, neither of which exists. Replaced with what CI auto-config actually does (from FrameworkBootstrap.applyCiOverrides), which also preserves the README's CI bullets.

Checklist

  • Docs-only; no code changes
  • All 23 docs links resolve to existing files in docs-site/docs
  • Version, image and file references re-checked against the repo

🤖 Generated with Claude Code

shossain786 and others added 5 commits October 10, 2026 23:37
…e claims

- README: 851 -> ~325 lines. Reference sections (API testing, WaitEngine,
  Retry, Grid, profiles, extension points, CI/CD, @precondition, design
  philosophy) are replaced by a Learn More table linking the docs site;
  each already has a docs page.
- Fix: README said selenium-boot.yml was required; it is optional and
  every key defaults (matches ConfigurationLoader and the Quickstart).
- Fix: README documented -Denv=staging for profiles; the real property
  is -Dselenium.boot.profile.
- Fix: Documentation link pointed at the old GitHub Pages URL.
- docs/ci/github-actions: replace the speculative headless section
  (browser.type, SELENIUM_HEADLESS) with what CI auto-config does,
  taken from FrameworkBootstrap.applyCiOverrides, so no README content is lost.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…s, move related tools below Learn More

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@shossain786
shossain786 merged commit 3285c28 into master Oct 10, 2026
@shossain786
shossain786 deleted the docs/readme-slim branch October 10, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant