Skip to content

chore: update sdk readmes - #1606

Open
openfeaturebot wants to merge 1 commit into
mainfrom
update-sdk-readmes
Open

openfeaturebot wants to merge 1 commit into
mainfrom
update-sdk-readmes

Conversation

@openfeaturebot

Copy link
Copy Markdown
Contributor

The PR was automatically generated via the update-sdk-docs GitHub workflow.

@openfeaturebot
openfeaturebot requested review from a team as code owners October 21, 2026 08:23
@netlify

netlify Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for openfeature ready!

Name Link
🔨 Latest commit e6c6308
🔍 Latest deploy log https://app.netlify.com/projects/openfeature/deploys/6ae30141884473c79d356f2e
😎 Deploy Preview https://deploy-preview-1606--openfeature.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 41d4e20f-a3b3-4f94-be07-c07a9e6678ea
Commits

Reviewing files that changed from the base of the PR and between 8d67a47 and 52ae7f6.

Files selected for processing: 18
  • docs/reference/sdks/client/dart.mdx
  • docs/reference/sdks/client/kotlin.mdx
  • docs/reference/sdks/client/swift.mdx
  • docs/reference/sdks/client/web/angular.mdx
  • docs/reference/sdks/client/web/index.mdx
  • docs/reference/sdks/client/web/react.mdx
  • docs/reference/sdks/server/cpp.mdx
  • docs/reference/sdks/server/dart.mdx
  • docs/reference/sdks/server/dotnet.mdx
  • docs/reference/sdks/server/go.mdx
  • docs/reference/sdks/server/java.mdx
  • docs/reference/sdks/server/javascript/index.mdx
  • docs/reference/sdks/server/javascript/nestjs.mdx
  • docs/reference/sdks/server/php.mdx
  • docs/reference/sdks/server/python.mdx
  • docs/reference/sdks/server/ruby.mdx
  • docs/reference/sdks/server/rust.mdx
  • src/datasets/sdks/sdk-compatibility.json
Files skipped from review as they are similar to previous changes: 16
  • docs/reference/sdks/client/web/index.mdx
  • docs/reference/sdks/server/python.mdx
  • docs/reference/sdks/server/javascript/index.mdx
  • docs/reference/sdks/server/java.mdx
  • docs/reference/sdks/server/dotnet.mdx
  • docs/reference/sdks/client/web/react.mdx
  • docs/reference/sdks/client/web/angular.mdx
  • docs/reference/sdks/client/swift.mdx
  • docs/reference/sdks/client/dart.mdx
  • docs/reference/sdks/server/cpp.mdx
  • docs/reference/sdks/server/rust.mdx
  • docs/reference/sdks/server/php.mdx
  • docs/reference/sdks/server/go.mdx
  • docs/reference/sdks/server/javascript/nestjs.mdx
  • docs/reference/sdks/client/kotlin.mdx
  • docs/reference/sdks/server/dart.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The pull request updates generated timestamps and release metadata in SDK reference pages. It also revises Ruby SDK documentation for provider behavior, isolated API instances, and hook inputs.

Changes: SDK reference updates

Layer / File(s) Summary
Refresh SDK reference metadata
docs/reference/sdks/client/..., docs/reference/sdks/server/..., src/datasets/sdks/sdk-compatibility.json
Updates generated-documentation timestamps. Updates Go release metadata to v1.20.0 and Ruby release and spec metadata to v0.8.1 and v0.9.0.
Document Ruby provider lifecycle and targeting
docs/reference/sdks/server/ruby.mdx
Revises Ruby examples and documentation for flag targeting, provider lookup by domain, lifecycle events, initialization, shutdown, and evaluation errors. Removes the custom-timeout example.
Document isolated Ruby APIs and hook inputs
docs/reference/sdks/server/ruby.mdx
Documents isolated API state, provider registration constraints, logger behavior, and hook context and input freezing rules.

Priority: Low

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Other

Suggested reviewers: aepfli, jonathannorris

Merge Risk: Minimal · previous review 52ae7

The SDK reference updates are ready to merge after normal checks.

Architecture risk: Low · up to 7e74d

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 17 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/reference/sdks/client/dart.mdx: Updated the documentation’s “Last updated” timestamp to Wed Oct 21 2026 08:23:35 GMT+0000 from Tue Oct 20 2026 08:23:55 GMT+0000.
  • observed — Modified behavior in docs/reference/sdks/client/kotlin.mdx: Updated the generated-documentation “Last updated” timestamp.
  • observed — Modified behavior in docs/reference/sdks/client/swift.mdx: The generated documentation timestamp was updated from Tue Oct 20 2026 08:23:55 GMT+0000 to Wed Oct 21 2026 08:23:35 GMT+0000.
  • observed — Modified behavior in docs/reference/sdks/client/web/angular.mdx: Updated the documentation’s “Last updated” timestamp to Wed Oct 21 2026 08:23:35 GMT+0000.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title identifies an SDK documentation update, which matches the main changes. The term "readmes" is broader than the modified reference files but remains related.
Description check Passed The description states that the changes were automatically generated by the update-sdk-docs workflow. This is directly related to the documentation updates.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (18 skipped: 18 unsupported.)

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@openfeaturebot
openfeaturebot force-pushed the update-sdk-readmes branch 6 times, most recently from 75e0e75 to f62209f Compare October 28, 2026 08:18
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
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