Skip to content

docs(react): clarify provider status handling - #1445

Open
pacocartones wants to merge 1 commit into
open-feature:mainfrom
pacocartones:codex/docs-provider-status
Open

docs(react): clarify provider status handling#1445
pacocartones wants to merge 1 commit into
open-feature:mainfrom
pacocartones:codex/docs-provider-status

Conversation

@pacocartones

Copy link
Copy Markdown

Summary

  • add a React FAQ recipe that distinguishes provider startup from ERROR and FATAL states
  • clarify that useWhenProviderReady is a boolean readiness gate and should not be used as the only status signal for a custom loader
  • show useOpenFeatureClientStatus as the status-aware alternative for fail-open UIs

Related to #1435; this documents the existing API only and intentionally does not change Suspense behavior or add a new API.

Validation

  • npm exec prettier -- --check packages/react/README.md
  • git diff --check

The repository-wide npm run format check is not clean in this Windows checkout before this change (it reports existing formatting differences across 270 unrelated files); the changed README passes the focused formatter check.

Signed-off-by: pacocartones <manusanchezhl@gmail.com>
@pacocartones
pacocartones requested review from a team as code owners August 4, 2026 10:25
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bac00754-1d8c-4e94-8959-ffdfdf0cfa33

📥 Commits

Reviewing files that changed from the base of the PR and between 78964f7 and e3a71e1.

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

📝 Walkthrough

Walkthrough

The React README adds FAQ guidance and an example for distinguishing provider NOT_READY from terminal ERROR or FATAL states. The example renders startup and failure UI while evaluations continue using code defaults.

Changes

Provider status documentation

Layer / File(s) Summary
Provider status handling example
packages/react/README.md
Adds useOpenFeatureClientStatus guidance for startup, terminal failure, and normal sidebar rendering. The example states that evaluations use code defaults after terminal failure.

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

Possibly related issues

  • open-feature/js-sdk#1435 — The README documents the NOT_READY versus terminal ERROR/FATAL handling described in this issue.

Suggested reviewers: openfeaturebot

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description accurately explains the documentation changes and validation performed.
Title check ✅ Passed The title clearly identifies the React documentation change about provider status handling.
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.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

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.

1 participant