Skip to content

docs: Introduce the sbt 2.x plugins in README to make them discoverable - #658

Merged
xerial merged 1 commit into
mainfrom
docs/readme-sbt-plugins
Jul 20, 2026
Merged

docs: Introduce the sbt 2.x plugins in README to make them discoverable#658
xerial merged 1 commit into
mainfrom
docs/readme-sbt-plugins

Conversation

@xerial

@xerial xerial commented Jul 20, 2026

Copy link
Copy Markdown
Member

Why

The sbt 2.x plugins (sbt-uni, sbt-uni-crossproject, sbt-uni-playwright) fill real gaps for any sbt 2.x project — portable-scala's crossproject and a maintained Playwright JSEnv are not otherwise available on sbt 2.x — but the top-level README never mentioned them, so external users had no way to discover them.

What

Adds an sbt 2.x Plugins section to README.md with:

  • a table describing each plugin, linked to its reference docs page
  • project/plugins.sbt snippets for adding each plugin
  • a minimal crossProject example showing the Pure layout

All snippets follow the verified usage from docs/build/*.md.

🤖 Generated with Claude Code

https://claude.ai/code/session_01X28nzmwNHfxNC8c1GnHqBM

The sbt-uni, sbt-uni-crossproject, and sbt-uni-playwright plugins fill real
gaps for any sbt 2.x project (crossproject and a maintained Playwright JSEnv
are not otherwise available there), but the README never mentioned them.
Surface them with usage snippets and links to the reference docs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01X28nzmwNHfxNC8c1GnHqBM
@github-actions github-actions Bot added the doc Improvements or additions to documentation label Jul 20, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to document the new sbt 2.x plugins (sbt-uni, sbt-uni-crossproject, and sbt-uni-playwright), providing installation snippets and usage examples. Feedback was given to correct a misleading documentation link at the end of the section, suggesting pointing readers to the individual plugin links in the table instead.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md
Comment on lines +63 to +64
See the [build plugin docs](https://wvlet.org/uni/build/sbt-uni) for
details.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The link points specifically to the sbt-uni documentation, which is misleading since this section introduces three different plugins, each with its own documentation page. It is clearer to refer readers to the individual links in the table above.

Suggested change
See the [build plugin docs](https://wvlet.org/uni/build/sbt-uni) for
details.
See the individual plugin links in the table above for detailed documentation.

@xerial
xerial merged commit 208b434 into main Jul 20, 2026
16 checks passed
@xerial
xerial deleted the docs/readme-sbt-plugins branch July 20, 2026 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant