Skip to content

docs: refresh README public package guidance#17

Merged
hayabusa-cloud merged 1 commit into
mainfrom
docs/readme
May 15, 2026
Merged

docs: refresh README public package guidance#17
hayabusa-cloud merged 1 commit into
mainfrom
docs/readme

Conversation

@hayabusa-cloud
Copy link
Copy Markdown
Owner

Summary

This PR refreshes the README language set so the public package page exposes the benchmark workflow status and describes multishot callbacks using the current API terms.

Changes

  • Add the Benchmarks badge that links to the standalone public benchmark workflow.
  • Clarify the multishot subscriber callback contract across all READMEs.
  • State that OnStep observes MultishotStep, OnStop runs at most once when callbacks remain enabled until terminal observation, and step.Cancelled represents the -ECANCELED kernel verdict.

Signed-off-by: Robin He <git@hybscloud.com>
Copilot AI review requested due to automatic review settings May 15, 2026 18:20
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation-only refresh of the README family: adds a Benchmarks workflow badge and rewrites the multishot subscriber callback paragraph to reference the current API (OnStep/OnStop, MultishotStep, step.Cancelled, MultishotHandler).

Changes:

  • Add Benchmarks badge linking to the public-benchmarks.yml workflow.
  • Rewrite multishot callback contract paragraph using current API names.
  • Apply the same updates consistently across English, Chinese, Japanese, French, and Spanish READMEs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md Adds Benchmarks badge and updated multishot callback paragraph.
README.zh-CN.md Mirrors English changes in Simplified Chinese.
README.ja.md Mirrors English changes in Japanese.
README.fr.md Mirrors English changes in French.
README.es.md Mirrors English changes in Spanish.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@hayabusa-cloud hayabusa-cloud merged commit b999721 into main May 15, 2026
13 checks passed
@hayabusa-cloud hayabusa-cloud deleted the docs/readme branch May 15, 2026 18:24
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.

2 participants