chore: update sdk readmes#1370
Conversation
✅ Deploy Preview for openfeature ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates documentation across multiple OpenFeature SDKs, including Kotlin, Swift, Web, Dart, and .NET, primarily to synchronize with recent SDK releases and update metadata. Notable changes include a version bump and refactored usage examples for the Dart Server SDK, along with method signature updates and typo fixes in the .NET documentation. Review feedback identified a broken HTML structure in the Dart release badges, a redundant note about hook support, and a regression in the SDK compatibility dataset where Dart feature statuses were incorrectly downgraded.
| <a href="https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.19"> | ||
| <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.19&color=blue&style=for-the-badge" /> | ||
|
|
||
| <a href="https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.19"> | ||
| <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.19&color=blue&style=for-the-badge" /> |
There was a problem hiding this comment.
The release badge is duplicated and the first instance is missing its closing </a> tag, which breaks the HTML structure. Only one instance of the badge is needed.
<a href="https://github.com/open-feature/dart-server-sdk/releases/tag/v0.0.19">
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.0.19&color=blue&style=for-the-badge" />
|
|
||
| > [!NOTE] | ||
| > Invocation-level hooks are not yet supported. Hooks can currently be registered at the global or client level. |
There was a problem hiding this comment.
This note about invocation-level hooks is a duplicate of the one provided just above (lines 205-207). It should be removed to maintain documentation clarity and avoid redundancy.
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Targeting": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#targeting" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Hooks": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#hooks" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Logging": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#logging" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Domains": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#domains" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Eventing": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#eventing" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Tracking": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#tracking" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Transaction Context Propagation": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#transaction-context-propagation" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Shutdown": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#shutdown" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, | ||
| "Extending": { | ||
| "status": "✅", | ||
| "path": "/docs/reference/sdks/server/dart#extending" | ||
| "status": "❓", | ||
| "path": "/docs/reference/sdks/server/dart" | ||
| }, |
There was a problem hiding this comment.
The feature statuses for the Dart SDK have been downgraded to ❓ (Unknown) and the deep links (anchors) have been removed. This appears to be a regression in the compatibility dataset, as the corresponding documentation (dart.mdx) confirms these features are implemented. These values should be restored to reflect the actual implementation status and maintain link functionality.
"status": "✅",
"path": "/docs/reference/sdks/server/dart#providers"
},
"Targeting": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#targeting"
},
"Hooks": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#hooks"
},
"Logging": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#logging"
},
"Domains": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#domains"
},
"Eventing": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#eventing"
},
"Tracking": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#tracking"
},
"Transaction Context Propagation": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#transaction-context-propagation"
},
"Shutdown": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#shutdown"
},
"Extending": {
"status": "✅",
"path": "/docs/reference/sdks/server/dart#extending"
openfeaturebot
force-pushed
the
update-sdk-readmes
branch
from
4d747e7 to
cd6f70a
Compare
openfeaturebot
force-pushed
the
update-sdk-readmes
branch
from
cd6f70a to
e7d2121
Compare
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
openfeaturebot
force-pushed
the
update-sdk-readmes
branch
from
e7d2121 to
27b0409
Compare
2 participants
The PR was automatically generated via the update-sdk-docs GitHub workflow.