Skip to content

docs: update Dart SDK sources and add client beta guide - #1483

Open
ABC2015 wants to merge 1 commit into
open-feature:mainfrom
ABC2015:docs/dart-sdk-rename
Open

ABC2015 wants to merge 1 commit into
open-feature:mainfrom
ABC2015:docs/dart-sdk-rename

Conversation

@ABC2015

@ABC2015 ABC2015 commented Sep 15, 2026

Copy link
Copy Markdown

The Dart repository was renamed to open-feature/dart-sdk, while the website still fetched its old root README, advertised server 0.0.23, and said the client SDK was unpublished. Fetch each SDK's package README from the renamed monorepo, refresh server documentation/compatibility data to 0.0.24, and add a discoverable Dart client-beta guide for the published 0.0.1-beta.1 package.

The client is explicitly beta and excluded from the support matrix until conformance is complete. Package names, Dart imports, SDK minimums, and unrelated SDK matrix entries are preserved. Client README clarification and canonical link updates are also submitted in open-feature/dart-sdk#173; coordinate that source update so later regeneration retains the revised wording. The server guide was generated from the current main package README; client content includes the documentation-only README corrections from #173.

Validation: production Docusaurus build and targeted dataset ESLint pass. The initial build failed identically on unchanged upstream because this Windows session exports DEBUG=release; removing only that variable from the build child process resolves the build, without changing source or machine settings. Standalone TypeScript checking reports existing upstream errors (missing module/assets, C++ dataset entry, and search-client types); these also reproduce on unchanged main. No validation or branch protection was disabled.

Signed-off-by: ABC2015 6826984+ABC2015@users.noreply.github.com

Signed-off-by: Jeremy Andrews <jandrews@venturseed.com>
@ABC2015
ABC2015 requested review from a team as code owners September 15, 2026 18:35
@netlify

netlify Bot commented Sep 15, 2026

Copy link
Copy Markdown

Deploy Preview for openfeature ready!

Name Link
🔨 Latest commit 31dcc38
🔍 Latest deploy log https://app.netlify.com/projects/openfeature/deploys/6aa98ffd679a4a0008e1e786
😎 Deploy Preview https://deploy-preview-1483--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 Sep 15, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 968d8706-7d3f-4ed0-9431-09ddf9985820

📥 Commits

Reviewing files that changed from the base of the PR and between a16fd67 and 31dcc38.

📒 Files selected for processing (6)
  • docs/reference/sdks/client/dart.mdx
  • docs/reference/sdks/server/dart.mdx
  • src/datasets/sdks/dart-client.ts
  • src/datasets/sdks/dart.ts
  • src/datasets/sdks/index.ts
  • src/datasets/sdks/sdk-compatibility.json

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


📝 Walkthrough

Walkthrough

The pull request adds beta Dart client SDK documentation and catalog metadata. It updates server Dart SDK documentation, repository references, package paths, and release data for the unified repository and version 0.0.24.

Changes

Dart SDK updates

Layer / File(s) Summary
Dart client SDK documentation
docs/reference/sdks/client/dart.mdx
Adds installation, usage, provider, lifecycle, scope, and archive validation documentation for the beta client SDK.
Unified Dart repository documentation
docs/reference/sdks/server/dart.mdx
Updates repository links, release information, client SDK references, dependency version, and wording.
Dart SDK catalog registration
src/datasets/sdks/dart-client.ts, src/datasets/sdks/dart.ts, src/datasets/sdks/index.ts, src/datasets/sdks/sdk-compatibility.json
Registers the beta client SDK, updates server SDK metadata, and points compatibility data to release 0.0.24.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: aepfli

Merge Risk: ⚪ Minimal · up to 31dcc

The beta client documentation and catalog metadata align with the published packages, and the server release data matches version 0.0.24.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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 3…
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.
Title check ✅ Passed The title clearly summarizes the main changes: updating Dart SDK sources and adding a client beta guide.
Description check ✅ Passed The description directly explains the Dart repository rename, server documentation refresh, client beta guide, support-matrix status, and validation results.

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