Skip to content

fix: correct typos in history documentation#2662

Open
noritaka1166 wants to merge 1 commit into
SeleniumHQ:trunkfrom
noritaka1166:fix-typos-history
Open

fix: correct typos in history documentation#2662
noritaka1166 wants to merge 1 commit into
SeleniumHQ:trunkfrom
noritaka1166:fix-typos-history

Conversation

@noritaka1166

@noritaka1166 noritaka1166 commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Description

Correct two typos in the English history documentation:

  • executeables -> executables
  • implementor -> implementer

Motivation and Context

This improves the readability and spelling accuracy of the Selenium history documentation without changing its meaning.

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

@netlify

netlify Bot commented Jun 20, 2026

Copy link
Copy Markdown

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit b9f9697

@qodo-code-review

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Fix typos in history documentation (executables, implementer)
📝 Documentation 🕐 Less than 5 minutes

Grey Divider

Description

• Correct spelling in the English history page to improve readability.
• Fix two words without changing meaning or structure.
High-Level Assessment

The following are alternative approaches to this PR:

1. Add automated spellcheck/linting in CI for docs
  • ➕ Prevents recurring typos across documentation with consistent enforcement
  • ➕ Reduces reviewer load for trivial spelling issues over time
  • ➖ Requires configuration/tuning (false positives, technical terms, names)
  • ➖ Adds CI time and an additional tool to maintain

Recommendation: The PR’s direct edits are the right immediate fix for two isolated typos. If typos are recurring, consider adding a lightweight docs spellcheck step in CI with an allowlist for Selenium-specific terminology.

Files changed (1) +2 / -2

Documentation (1) +2 / -2
history.en.mdFix two spelling errors in history page headings/body text +2/-2

Fix two spelling errors in history page headings/body text

• Corrects the heading "executeables" to "executables" and changes "implementor" to "implementer" in a paragraph about specification work. No content meaning or formatting is otherwise altered.

website_and_docs/content/documentation/about/history.en.md

@qodo-code-review

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

Grey Divider


Informational

1. Broken deep-link anchor 🐞 Bug ☼ Reliability
Description
Changing the H3 heading text changes the generated HTML fragment ID for that section (e.g., the old
typo-based #...executeables anchor will no longer exist), which can break existing deep
links/bookmarks to this heading.
Code

website_and_docs/content/documentation/about/history.en.md[100]

+### A story of driver executables
Evidence
The PR changes a markdown heading; Hugo generates heading IDs/anchors from heading text when plain
ID anchors are enabled, so the fragment for this section changes along with the heading text.

website_and_docs/content/documentation/about/history.en.md[96-102]
website_and_docs/hugo.toml[33-38]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The heading text change will change the section’s generated fragment identifier, potentially breaking existing inbound links/bookmarks that use the old (typo) fragment.

### Issue Context
This site is Hugo-based and is configured to generate plain heading ID anchors. To avoid breaking deep links, keep the corrected visible heading but add an explicit legacy anchor matching the previous generated ID.

### Fix Focus Areas
- website_and_docs/content/documentation/about/history.en.md[98-102]

### Suggested fix
Add an explicit legacy anchor immediately before the heading, e.g.:

```md
<a id="a-story-of-driver-executeables"></a>
### A story of driver executables
```

(Use the exact legacy fragment ID you want to preserve.)

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

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