Skip to content

docs: Clarify project maturity level in the README - #330

Merged
grahamking merged 1 commit into
mainfrom
gk-honesty
Aug 7, 2026
Merged

docs: Clarify project maturity level in the README#330
grahamking merged 1 commit into
mainfrom
gk-honesty

Conversation

@grahamking

@grahamking grahamking commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

"v0.2" should have made this obvious already, but more honestly can't
hurt.

Signed-off-by: Graham King grahamk@nvidia.com

Summary by CodeRabbit

  • Documentation
    • Added a maturity notice explaining that Switchyard is pre-alpha, rapidly evolving, and not intended for production use.
    • Clarified that APIs and algorithms may change significantly before version 1.0.

"v0.2" should have made this obvious already, but more honestly can't
hurt.

Signed-off-by: Graham King <grahamk@nvidia.com>
@grahamking
grahamking requested a review from a team as a code owner August 7, 2026 17:28
@grahamking grahamking changed the title doc: Clarify project maturity level in the README docs: Clarify project maturity level in the README Aug 7, 2026
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 183ed163-60eb-4fd8-a4dc-b847b8851a60

📥 Commits

Reviewing files that changed from the base of the PR and between 74b8990 and cd3f91e.

📒 Files selected for processing (1)
  • README.md

Walkthrough

The README now states that Switchyard is pre-alpha, subject to significant API and algorithm changes before v1.0, and not intended for production use.

Changes

Maturity documentation

Layer / File(s) Summary
Add maturity notice
README.md
Adds a Maturity section that documents pre-alpha status, expected breaking changes, and the production-use warning.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

A rabbit reads the README bright,
“Pre-alpha” marks the path in sight.
APIs may change and hop,
So production use must stop.
🐇 Clear warnings guide the way.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the README change that clarifies the project's maturity level.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch

Comment @coderabbitai help to get the list of available commands.

@grahamking
grahamking merged commit 8d6adfe into main Aug 7, 2026
14 of 15 checks passed
@grahamking
grahamking deleted the gk-honesty branch August 7, 2026 17:36
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