Skip to content

docs(getting-started): make example runnable as written (Fixes #43) - #44

Merged
shossain786 merged 1 commit into
seleniumboot:masterfrom
mdraza7544:fix/43-getting-started-placeholder-values
Sep 12, 2026
Merged

shossain786 merged 1 commit into
seleniumboot:masterfrom
mdraza7544:fix/43-getting-started-placeholder-values

Conversation

@mdraza7544

Copy link
Copy Markdown
Contributor

What & why

Fixes #43

The Getting Started example was using https://your-app.com as the base URL and checking for a Dashboard title. If someone followed the example as-is, the test would not pass because those values were only placeholders.

I updated the example so it can be run without changing anything first.

Changes

  • Changed the base URL to https://example.com.
  • Added the required execution.mode: local.
  • Changed LoginTest to a simple SmokeTest.
  • Replaced the Dashboard title check with an assertion for the Example Domain heading.
  • Updated the TestNG example and project structure to match the new test name.
  • Added a small note explaining how to switch to your own application after trying the example.

Type of change

  • Bug fix
  • New feature (opt-in, aligned with the framework philosophy)
  • Documentation
  • Internal refactor / test coverage

Checklist

  • No framework source code was changed.
  • Only the Getting Started documentation was updated.
  • The example uses the existing Selenium Boot APIs.
  • Step 2, Step 3, and Step 4 are consistent with each other.

Notes for reviewers

The main goal here is to make the first example easier to follow for someone trying Selenium Boot for the first time.

The example now uses example.com as the target and checks the Example Domain heading, so the values in the guide are no longer dependent on a user's own application.

@shossain786

Copy link
Copy Markdown
Contributor

@mdraza7544 Thanks for this — really appreciate you picking up #43 and fixing it properly. The self-contained example against example.com is the right approach. CI's green; will do a proper review pass and merge shortly.

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.

getting-started.md example test cannot pass against any real target as written

2 participants