Skip to content

Split extended_features into 10 thematic subdocs#93

Merged
JE-Chen merged 1 commit intomainfrom
dev
Apr 27, 2026
Merged

Split extended_features into 10 thematic subdocs#93
JE-Chen merged 1 commit intomainfrom
dev

Conversation

@JE-Chen
Copy link
Copy Markdown
Member

@JE-Chen JE-Chen commented Apr 27, 2026

Summary

The extended_features doc had grown to 670 lines with 47 sections in one
file, all sharing a single page. This PR splits it into ten cluster docs
(Eng + Zh symmetric) and turns extended_features_doc.rst into a thin
landing page with a toctree.

New folders under both docs/source/Eng/doc/ and docs/source/Zh/doc/:

  • architecture — System overview · Action lifecycle
  • backends — Selenium · Playwright · Cloud Grid · Appium (incl. mobile gestures)
  • reports — Reports · Reporting & CI · CI reproducibility & long-term observability
  • observability — Observability · tooling · triage / production
  • orchestration — Test orchestration · DX · fan-out · CLI polish
  • quality_security — Q&S · probes · PII / visual review · form auto-fill / a11y diff
  • browser_internals — internals · locale · storybook / shadow DOM · CDP tap / cross-browser / state diff
  • data_auth_api — Test data (+ determinism) · auth/API/database · contract testing
  • integrations — Recorder · CI/integrations · AI assistance · MCP · Action JSON LSP
  • tooling — reliability · browser pool/BiDi · HAR replay · impact · bootstrapper · sel→pw · formatter · POM codegen · WR_sleep
  • cookbook — examples · test tiers · thematic façade

Content is verbatim copy of the corresponding sections from the old file
— no rewriting, just regrouping. The old extended_features_doc.rst
keeps the introduction and now consists of a toctree pointing at the new
cluster docs, so the existing RTD URL continues to resolve.

Verification

  • sphinx-build -W --keep-going succeeds with zero warnings in a
    clean venv that mirrors the RTD environment (no project deps installed,
    only sphinx + sphinx-rtd-theme + sphinxcontrib-mermaid).

Test plan

  • RTD build green on this branch
  • Navigation still surfaces every cluster page under "Extended features"

Convert the monolithic extended_features_doc.rst into a thin landing page
that points to ten cluster docs:

  - architecture
  - backends
  - reports
  - observability
  - orchestration
  - quality_security
  - browser_internals
  - data_auth_api
  - integrations
  - tooling
  - cookbook

Same content, restructured for navigation; sphinx-build -W passes in a
selenium-less venv that mirrors the RTD environment.
@codacy-production
Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@sonarqubecloud
Copy link
Copy Markdown

@JE-Chen JE-Chen merged commit aaeff8f into main Apr 27, 2026
22 checks passed
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