Skip to content

docs: lead the README with what it does and where it runs - #4

Merged
waple0820 merged 5 commits into
mainfrom
docs/readme-any-browser
Sep 24, 2026
Merged

waple0820 merged 5 commits into
mainfrom
docs/readme-any-browser

Conversation

@waple0820

@waple0820 waple0820 commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

Rewrites the README around the question a newcomer asks first: what is this, and will it work with my browser?

  • Opening — one line: plug any browser into Jev. A three-line code sample right under it.
  • Results — the end-to-end table across 15 browsers (cloud, local, self-hosted; with and without rendering), result and average steps each.
  • Plug in a browser — Moli as the worked example, then a table showing every other browser is one first line different.
  • How it works — a four-row comparison of a position-based reader against reading the DOM, and what each reads on browsers without real layout.
  • Why it matters — five points.
  • Try it — CLI output refreshed from a real run on Moli today.
  • Under the hood — the previous detail sections, now collapsed.

Every number is from runs in the last two days; all external links checked.

Open with the one-line purpose -- plug any CDP browser into Jev -- and the
results table across fifteen browsers, then how to connect one (Moli as the
example, every other browser one line different), a short account of how
reading the DOM differs from reading layout, and why that matters. The
details of the decision request, same-name controls, retrieval and page
changes move under collapsible sections.

Signed-off-by: waple0820 <feng.wang@lexmount.com>
@github-actions

github-actions Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Claude finished @waple0820's task in 16s —— View job


Documentation-only change (README.md). No bugs or security issues found.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated Claude review completed. Review run: https://github.com/lexmount/jev-nolayout/actions/runs/35994814072. Please check Claude's inline feedback and summary comment for details.

Drop the introduction of Jev and the opening code sample; the first thing a
reader sees is that any CDP browser plugs in. Results keep one line of
context, call the column pass rate, drop the footnotes and the Lexmount
Chrome row. Connecting shows two worked examples: Moli in the cloud and
Lightpanda on the local machine.

Signed-off-by: waple0820 <feng.wang@lexmount.com>
@waple0820

Copy link
Copy Markdown
Contributor Author

Revised per review:

  1. The opening now leads with any browser — a heading, then one bold line (cloud, local or self-hosted; Chromium or not; even browsers that never draw a page).
  2. The introduction of Jev and the opening code sample are gone.
  3. Results: one line of context, column renamed Pass rate, footnotes removed, Lexmount Chrome row removed (badge updated to 14).
  4. Connecting now shows two examples: Moli (cloud) and Lightpanda (local). The Lightpanda snippet was run verbatim: 2 steps to the Latte article.

@github-actions

github-actions Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Claude finished @waple0820's task in 16s —— View job


Documentation-only change (README.md). No bugs or security issues found.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated Claude review completed. Review run: https://github.com/lexmount/jev-nolayout/actions/runs/35995691903. Please check Claude's inline feedback and summary comment for details.

Browsers with and without rendering, on the cloud and on the local machine,
reach Jev through the bridge over CDP. The diagram carries the project name,
so it replaces the markdown title rather than repeating it.

Signed-off-by: waple0820 <feng.wang@lexmount.com>
@waple0820

Copy link
Copy Markdown
Contributor Author

Added the overview diagram as the README banner (assets/overview.png). It carries the project name, so it replaces the markdown title instead of repeating it; the "Plug any browser into Jev" heading follows directly under it.

@github-actions

github-actions Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Claude finished @waple0820's task in 15s —— View job


Documentation-only change (README.md + overview.png). No bugs or security issues found.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated Claude review completed. Review run: https://github.com/lexmount/jev-nolayout/actions/runs/35999518486. Please check Claude's inline feedback and summary comment for details.

Say what it is first, then show the shape of it, then the results. With
the diagram no longer the banner, the markdown title comes back.

Signed-off-by: waple0820 <feng.wang@lexmount.com>
@github-actions

github-actions Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Claude finished @waple0820's task in 16s —— View job


Documentation-only change (README.md + overview.png). No bugs or security issues found.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated Claude review completed. Review run: https://github.com/lexmount/jev-nolayout/actions/runs/35999713191. Please check Claude's inline feedback and summary comment for details.

The table shows Jev completing web tasks; say so, and say what counts as a pass.

Signed-off-by: waple0820 <feng.wang@lexmount.com>
@github-actions

github-actions Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Claude finished @waple0820's task in 25s —— View job


Documentation-only change (README.md + overview.png). No bugs or security issues found.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated Claude review completed. Review run: https://github.com/lexmount/jev-nolayout/actions/runs/36000216552. Please check Claude's inline feedback and summary comment for details.

@waple0820
waple0820 merged commit fbed283 into main Sep 24, 2026
1 check passed
@waple0820
waple0820 deleted the docs/readme-any-browser branch September 24, 2026 13:14
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