Skip to content

Commit 93dd780

Browse files
Merge branch 'trunk' into fix-python-options-snippets-2621
2 parents e3ed0c1 + 7275687 commit 93dd780

13 files changed

Lines changed: 185 additions & 10 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
When reviewing a pull request, also follow the guidelines in .github/pr_review.md.

.github/pr_review.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# PR Review Guidelines
2+
3+
Use these guidelines when reviewing pull requests for this documentation repository.
4+
5+
## Priorities
6+
7+
- First look for changes that can break rendered documentation: malformed Markdown, Hugo
8+
shortcodes, `tabpane` / `tab` pairs, code fences, front matter, anchors, or translated page
9+
structure. Small whitespace and delimiter changes can break code blocks or entire sections.
10+
- Treat `gh-codeblock` paths and line ranges as correctness-sensitive. If `examples/` changed,
11+
search `website_and_docs/content` for references to the changed files. If docs changed a
12+
`gh-codeblock`, verify the path still exists and the line range shows exactly the intended
13+
snippet.
14+
- Check translation maintenance against `website_and_docs/content/documentation/about/style.en.md`.
15+
English text changes do not require translated files in the same PR, but changed translation
16+
files must preserve working front matter, shortcodes, tabs, code blocks, and example references.
17+
When the style guide requires translated code examples, verify the matching translated files were
18+
updated.
19+
- For examples, review code correctness only as it affects the published docs: runnable snippets,
20+
assertions where practical, stable demo pages, and matching documentation references.
21+
22+
## Documentation checks
23+
24+
- Front matter should match the surrounding page style.
25+
- `linkTitle` should be short and title-cased; `title` should use sentence case.
26+
- General prose should be language-independent. Put binding-specific code or behavior in language
27+
tabs.
28+
- When all tabs use `gh-codeblock`, the `tabpane` should use `text=true`. When only some tabs use
29+
shortcodes or markdown, those tabs need `text=true`.
30+
- `gh-codeblock` lines must not be indented. Plain text in markdown tabs also must not be
31+
accidentally indented into a code block.
32+
33+
## Do not comment on
34+
35+
- Missing translated files for ordinary English text changes.
36+
- Subjective wording preferences unless the text is inaccurate, confusing, or inconsistent with
37+
the Selenium docs style guide.
38+
- Formatting nits that do not affect rendering, code block structure, shortcode parsing, or
39+
maintainability.
40+
- CI status without a clear connection to the diff.
41+
42+
## Review style
43+
44+
- Label severity as blocking, important, or minor.
45+
- Make each comment actionable: state the risk, why it matters, and the smallest fix.
46+
- Include file and line context when possible.
47+
- Do not leave duplicate comments for the same root cause.
48+
- It is acceptable to report no findings.

.gitignore

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,37 @@
22
public/
33
node_modules
44
.DS_Store
5+
6+
/.local/*
7+
!/.local/README.md
8+
9+
# Agent-specific local instruction overrides (keep private, never commit)
10+
AGENTS.local.md
11+
CLAUDE.local.md
12+
GEMINI.local.md
13+
14+
# Security
15+
.env
16+
.env.local
17+
18+
# AI agent local state (most common)
19+
/.claude
20+
/.cursor
21+
/.continue
22+
/.cline
23+
/.windsurf
24+
/.zencoder
25+
26+
# Common per-tool config/rules files people accidentally add
27+
/.cursorignore
28+
/.cursorrules
29+
/.windsurfrules
30+
/.continuerc.json
31+
32+
# Common generated transcripts
33+
*_cline_transcript.json
34+
.copilot-chat-history.json
35+
536
website_and_docs/.hugo_build.lock
637
website_and_docs/resources
738
*.png

.local/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Local-only workspace
2+
3+
This directory is for repo-local private work that should not be committed:
4+
5+
- personal agent instructions, preferably `.local/AGENTS.md`;
6+
- personal agent skills under `.local/agent/skills/local-*`;
7+
- scratch code;
8+
- private experiments;
9+
- local helper scripts;
10+
- generated outputs;
11+
- temporary notes and prompts.
12+
13+
Everything in this directory is ignored by Git except this README.
14+
15+
Do not make production code, tests, CI, release tooling, or public documentation depend on files
16+
in this directory. If a local experiment becomes useful to the project, move it into a tracked
17+
source, test, docs, example, or scripts directory and review it normally.

.pr_agent.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[pr_reviewer]
2+
extra_instructions = "Please look at the guidelines in .github/pr_review.md when evaluating this PR."
3+
4+
[github_app]
5+
pr_commands = [
6+
"/agentic_describe",
7+
"/agentic_review",
8+
]
9+
handle_push_trigger = true
10+
push_commands = [
11+
"/agentic_review",
12+
]

AGENTS.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# AGENTS.md
2+
3+
## Project overview
4+
5+
- Purpose: official Selenium website and documentation, built with Hugo and Docsy.
6+
- Primary content: Markdown, HTML, Hugo templates, site assets, structured data, and runnable
7+
examples in Java, Python, .NET, Ruby, JavaScript, and Kotlin.
8+
- Setup and installation details live in `README.md`. Use its Quick start section for the current
9+
Hugo Extended version, Docsy requirements, and local setup guidance.
10+
11+
## Local contributor customization
12+
13+
- The `.local/` directory is available for customization, generated artifacts, scratch work,
14+
and temporary files. It is ignored by Git except for `.local/README.md`.
15+
- A contributor may create `.local/AGENTS.md` for personal repo-specific instructions and
16+
preferences. Before beginning any task, check whether `.local/AGENTS.md` exists; if it
17+
exists, read it with your file-reading tool and apply it as the contributor's local
18+
instruction overlay.
19+
- If `.local/agent/skills/` exists, inspect its `*/SKILL.md` files and treat them as
20+
additional user-defined skills.
21+
22+
## Repository map
23+
24+
- `website_and_docs/`: Hugo site root. Run local Hugo commands from here.
25+
- `website_and_docs/content/`: Published site content, including docs, blog posts, project pages,
26+
and translations.
27+
- `website_and_docs/content/documentation/`: Main Selenium documentation. Read
28+
`about/style.en.md` for documentation style conventions before editing docs.
29+
- `website_and_docs/layouts/`: Hugo templates and shortcodes.
30+
- `website_and_docs/assets/`, `website_and_docs/static/`, `website_and_docs/data/`: Site assets,
31+
static files, and structured data.
32+
- `examples/`: Runnable examples referenced from docs through `gh-codeblock`.
33+
- `scripts/`, `build-site.sh`, `netlify.toml`: Build, preview, release, and deploy support.
34+
- `website_and_docs/public/`, `website_and_docs/resources/`: Generated Hugo output/cache; avoid
35+
manual edits.
36+
37+
## Standard commands
38+
39+
- Preview site locally: `cd website_and_docs && hugo server`
40+
- Preview without Hugo cache: `cd website_and_docs && hugo server --ignoreCache`
41+
- Build site like CI: `./build-site.sh`
42+
- Java examples: `cd examples/java && mvn test`
43+
- Python examples: `cd examples/python && pytest`
44+
- JavaScript examples: `cd examples/javascript && npm test`
45+
- Ruby examples: `cd examples/ruby && bundle exec rspec`
46+
- Ruby example lint: `cd examples/ruby && bundle exec rubocop`
47+
- .NET examples: `cd examples/dotnet/SeleniumDocs && dotnet test`
48+
- Kotlin examples: `cd examples/kotlin && mvn test`
49+
50+
## Working guidance
51+
52+
- Prefer small, focused changes that match the existing structure and naming.
53+
- Follow `website_and_docs/content/documentation/about/style.en.md` for docs style. In particular,
54+
keep prose language-independent, put binding-specific code in tabs, use `gh-codeblock` for
55+
runnable snippets, and do not indent `gh-codeblock` lines.
56+
- Changes under `examples/` probably require matching markdown updates. Search
57+
`website_and_docs/content` for affected `gh-codeblock` paths and update line ranges after moving,
58+
adding, or removing lines.
59+
- For docs/layout changes, run `./build-site.sh` when practical. For example changes, run the
60+
relevant binding's example tests and check affected `gh-codeblock` references.
61+
- For PR review tasks, read `.github/pr_review.md` before reviewing.
62+
- GitHub Actions builds the site on PRs touching `website_and_docs/**`. Deploys occur from `trunk`
63+
when a commit message contains `[deploy site]`; output is pushed to `publish`.
64+
- Never commit secrets, tokens, cookies, private keys, or local credentials. Tracked project files
65+
must not depend on `.local/`.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This repository uses @AGENTS.md as the canonical repo instruction file.

website_and_docs/content/blog/2021/selenium-4-beta-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ By "**almost everything**", I mean that under the covers there have
4343
been substantial changes. We've rewritten the Selenium server to allow
4444
it to work not only in the familiar "standalone" and "hub and node"
4545
modes, but also in a new "distributed" mode, which makes it
46-
signifcantly easier to deploy to something such as Kubernetes in a way
46+
significantly easier to deploy to something such as Kubernetes in a way
4747
that scales well.
4848

4949
The new server is also wired up with support for [OpenTelemetry][] and

website_and_docs/content/documentation/webdriver/elements/locators.en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -380,9 +380,9 @@ and then a child element of that parent, you can instead combine those two `Find
380380

381381
### ByAll
382382

383-
The `ByAll` class enables you to utilize two By locators at once, finding elements that mach _either_ of your By locators.
383+
The `ByAll` class enables you to utilize two By locators at once, finding elements that match _either_ of your By locators.
384384
For example, instead of having to utilize two `FindElement()` functions to find the username and password input fields
385-
seperately, you can instead find them together in one clean `FindElements()`
385+
separately, you can instead find them together in one clean `FindElements()`
386386

387387
{{< tabpane langEqualsHeader=true >}}
388388
{{< tab header="Java" text=true >}}

website_and_docs/content/documentation/webdriver/elements/locators.ja.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -371,8 +371,8 @@ functions into one.
371371

372372
### ByAll
373373

374-
The `ByAll` class enables you to utilize two By locators at once, finding elements that mach _either_ of your By locators.
375-
For example, instead of having to utilize two `FindElement()` functions to find the username and password input fields seperately,
374+
The `ByAll` class enables you to utilize two By locators at once, finding elements that match _either_ of your By locators.
375+
For example, instead of having to utilize two `FindElement()` functions to find the username and password input fields separately,
376376
you can instead find them together in one clean `FindElements()`
377377

378378
{{< tabpane langEqualsHeader=true >}}

0 commit comments

Comments
 (0)