Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update sdk section #49

Closed
wants to merge 16 commits into from
Closed

docs: update sdk section #49

wants to merge 16 commits into from

Conversation

htessaro
Copy link
Contributor

No description provided.

Copy link

netlify bot commented Jan 31, 2024

Deploy Preview for bucketeer-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit c48300e
🔍 Latest deploy log https://app.netlify.com/sites/bucketeer-docs/deploys/65bba011ac54640008b299ce
😎 Deploy Preview https://deploy-preview-49--bucketeer-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Comment on lines 139 to 153
```dart showLineNumbers
/// It will unlock without waiting until the fetching variation process finishes
int timeout = 1000;
int timeout = 5000;

await BKTClient.initialize(config: config, user: user, timeoutMillis: timeout);
final client = BKTClient.instance;
if (result.isSuccess) {
final client = BKTClient.instance;
if (showNewFeature) {
/// The Application code to show the new feature
} else {
/// The code to run if the feature is off
}
} else {
/// Handle the error when there is no cache or the cache is not updated
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cre8ivejp, the original code didn't use a conditional to treat timeout errors. I tried to adapt the code from the update section. However, I don't know if it's correct.

docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/android/index.md Outdated Show resolved Hide resolved
docs/sdk/server-side/node-js/index.md Outdated Show resolved Hide resolved
docs/sdk/server-side/go/index.md Outdated Show resolved Hide resolved
docs/sdk/index.mdx Outdated Show resolved Hide resolved
docs/sdk/index.mdx Outdated Show resolved Hide resolved
docs/sdk/index.mdx Outdated Show resolved Hide resolved
<td><CheckSVG/></td>
</tr>
<tr>
<td>Clone</td>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no Clone feature.
Please remove this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed. However, in previous comments, you mentioned a Clone feature that Go SDK has. I probably misunderstand. But what was that about?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this comment, I mentioned Close.
#49 (comment)

docs/sdk/index.mdx Outdated Show resolved Hide resolved
docs/sdk/client-side/flutter/index.md Show resolved Hide resolved
docs/sdk/client-side/flutter/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/javascript/index.md Outdated Show resolved Hide resolved
docs/sdk/client-side/ios/index.md Outdated Show resolved Hide resolved
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This category contains topics explaining how to configure Bucketeer's Flutter SDK.

:::caution Flutter SDK Version (Beta)

The Flutter JS SDK is currently in its Beta stage.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The Flutter JS SDK is currently in its Beta stage.
The Flutter SDK is currently in its Beta stage.


The Flutter JS SDK is currently in its Beta stage.

If you find any issues or have suggestions for improvement, feel free to open an [issue](https://github.com/bucketeer-io/flutter-client-sdk/issues).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you find any issues or have suggestions for improvement, feel free to open an [issue](https://github.com/bucketeer-io/flutter-client-sdk/issues).
If you find any issues or have suggestions for improvement, feel free to open an [issue](https://github.com/bucketeer-io/flutter-client-sdk/issues).
The SDK doesn't support Flutter Web yet. All contributions are welcome!


await BKTClient.initialize(config: config, user: user, timeoutMillis: timeout);
final client = BKTClient.instance;
final result = await BKTClient.initialize(config: config, user: user, timeoutMillis: timeout);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please replace the whole code block with the following.

Suggested change
final result = await BKTClient.initialize(config: config, user: user, timeoutMillis: timeout);
/// It will unlock without waiting until the fetching variation process finishes
const int timeout = 5000;
final result = await BKTClient.initialize(config: config, user: user, timeoutMillis: timeout);
if (result.isSuccess) {
const client = BKTClient.instance;
if (showNewFeature) {
/// The Application code to show the new feature
} else {
/// The code to run if the feature is off
}
} else {
/// Handle the error when there is no cache or the cache is not updated
}

@cre8ivejp cre8ivejp changed the title Update sdk section docs: update sdk section Feb 2, 2024
@cre8ivejp
Copy link
Member

@heitortessaro, I left a few comments. Please take a look when you have time.

@cre8ivejp
Copy link
Member

Closing this in favor of #50

@cre8ivejp cre8ivejp closed this Feb 5, 2024
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.

2 participants