Repository navigation
docs(forward): clarify Decision API beta status - #28
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Mark Forward Decisions as Beta in the README, public resource documentation, and runnable example. State consistently: “The Decision API is in Beta. Its behavior may change in future updates.” Regenerate the API reference and record the clarification under Unreleased.
Why
The Decision documentation shipped without an explicit Beta notice. Users need to know that its behavior may change as the feature evolves.
Verification
uv run make docs-check(31 README snippets compiled)git diff --checkRuntime behavior, signatures, and dependencies are unchanged. No new tests or account-backed requests are needed for this documentation-only change; normal CI still runs on the PR.
Impact
The wording is aligned across Go, Python, and TypeScript. Generated documentation is updated; no contract-fixture or migration changes are needed. No credentials, logs, or generated test output are included.