Repository navigation
docs: fix invalid config keys and missing timeouts in parallel guide - #33
Merged
Merged
Conversation
Two copy-paste defects in guides/parallel.md, found while drafting the P1-5
SEO article and confirmed against SeleniumBootConfig / ConfigurationLoader
in 3.2.0:
- The guide documented a top-level `parallel: {enabled, threadCount}` block
and `browser.maxActiveSessions`. Neither exists — all three keys live
under `execution:` (SeleniumBootConfig.Execution: parallel, threadCount,
maxActiveSessions). ConfigurationLoader uses a default SnakeYAML
Constructor, which throws on unknown top-level properties, so copy-pasting
the old sample aborted the suite immediately with a YAMLException.
configuration.md already had the correct structure; used as reference.
- Every YAML sample in the guide omitted the required `timeouts:` block.
ConfigurationLoader.validate() requires timeouts.explicit and
timeouts.pageLoad as positive primitives (absent = 0), so even a
key-corrected sample still aborted with "Selenium Boot failed to
initialize". Same defect as the one fixed in the README under P1-6a
(860d4d2) — matched that fix's shape (complete, loadable minimal config).
Verified against real Maven Central 3.2.0 + ConfigurationLoader:
- Old documented sample: YAMLException, "Unable to find property 'parallel'
on class SeleniumBootConfig", exit 1.
- Corrected sample (both the "Configuration" and "Disabling parallel
execution" snippets): loads cleanly, exit 0, execution.parallel/
threadCount/maxActiveSessions and timeouts.explicit/pageLoad all read
back as configured.
Grepped the rest of docs-site/ and README/CHANGELOG for the same two
patterns (top-level `parallel:`, `maxActiveSessions` outside `execution:`,
YAML samples with no `timeouts:`) — no other current-doc instances found.
Two historical changelog entries (CHANGELOG.md, docs-site/docs/changelog.md)
describe the 0.3.0-era schema and were left untouched as historical record.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
3 tasks done
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.
Summary
guides/parallel.mddocumented a top-levelparallel: {enabled, threadCount}block andbrowser.maxActiveSessions— neither key exists. All three (parallel,threadCount,maxActiveSessions) live underexecution:perSeleniumBootConfig.Execution.ConfigurationLoader's default SnakeYAMLConstructorthrows on unknown top-level properties, so copy-pasting the guide's sample aborted the suite immediately.timeouts:block.ConfigurationLoader.validate()requirestimeouts.explicit/timeouts.pageLoadas positive values — same defect already fixed in the README (860d4d2 / P1-6a), fixed here to match.configuration.mdalready documented the correct structure and was used as the reference; no changes needed there.Test plan
SeleniumBootConfig.java/ConfigurationLoader.javain this repo to confirm the real key structure (execution.parallel,execution.threadCount,execution.maxActiveSessions,timeouts.explicit,timeouts.pageLoad).YAMLException: Unable to find property 'parallel' on class SeleniumBootConfig, exit 1.ConfigurationLoader.load()returns exit 0 withexecution.parallel/threadCount/maxActiveSessionsandtimeouts.explicit/pageLoadreading back as configured.cd docs-site && npm run build— succeeds, no broken-link warnings.docs-site/,README.md,CHANGELOG.mdfor the same two patterns (top-levelparallel:,maxActiveSessionsoutsideexecution:) — no other current-doc instances. Two changelog entries describing the 0.3.0-era schema were left untouched as historical record.Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com