Skip to content

docs: lead the README with durable workflows and trim prerequisites - #1887

Merged
dapr-bot merged 1 commit into
dapr:masterfrom
sicoyle:samkendziora/docs-readme-refresh
Nov 2, 2026
Merged

dapr-bot merged 1 commit into
dapr:masterfrom
sicoyle:samkendziora/docs-readme-refresh

Conversation

@sicoyle

@sicoyle sicoyle commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

The README now opens with what the Java SDK covers and adds a Workflows section with links to the docs and examples. The prerequisites are cut down to JDK 17, Maven or Gradle and the Dapr CLI, and dapr-sdk-workflows is added to the BOM examples. Before this, the README listed features without context and sent new users through a long IDE setup list.

Tested by checking every link, and by checking the dependency snippets against the published BOM.

🤖 Generated with Claude Code

Signed-off-by: Samantha Coyle <sam@diagrid.io>
Copilot AI balanced review requested due to automatic review settings November 2, 2026 15:25
@sicoyle
sicoyle requested review from a team as code owners November 2, 2026 15:25

Copilot AI 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.

🟢 Approval recommended

No active review issues block the README updates to workflow discovery, prerequisites, and dependency guidance.

No open issues 🎉

What changed in this PR

Updates the README to introduce the Java SDK’s capabilities with an emphasis on durable workflows and distinguish application prerequisites from SDK development tools.

Changes:

  • Adds a Workflows section linking to documentation and examples.
  • Simplifies prerequisites and moves contributor tooling guidance under Development.
  • Adds workflows to core BOM dependency examples and clarifies dependency version management.
File Description
README.md Improves onboarding, workflow discovery, dependency examples, and development setup guidance.

Review effort: Balanced

@codecov

codecov Bot commented Nov 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.63%. Comparing base (b2c8f21) to head (4bf009f).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master    #1887   +/-   ##
=========================================
  Coverage     80.63%   80.63%           
  Complexity     2850     2850           
=========================================
  Files           275      275           
  Lines          8459     8459           
  Branches        911      911           
=========================================
  Hits           6821     6821           
  Misses         1272     1272           
  Partials        366      366           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dapr-bot
dapr-bot merged commit 21703ec into dapr:master Nov 2, 2026
26 of 28 checks passed
@marcduiker

Copy link
Copy Markdown
Contributor

@holopin-bot @sicoyle sdk-badge Thank you! Here's a digital badge as a small token of appreciation.

@holopin-bot

holopin-bot Bot commented Nov 2, 2026

Copy link
Copy Markdown

Congratulations @sicoyle, the maintainer of this repository has issued you a badge! Here it is: https://holopin.io/claim/cmvzqbt8y0003jq07xilm68js

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants