Skip to content

fix: updates readme and docs#12

Merged
itsjavi merged 2 commits into
mainfrom
fix/update-readme
Jun 12, 2026
Merged

fix: updates readme and docs#12
itsjavi merged 2 commits into
mainfrom
fix/update-readme

Conversation

@pandeymangg

Copy link
Copy Markdown
Contributor

Updates the flutter sdk readme and the docs, also removes the flutter sdk ai plan

@pandeymangg pandeymangg requested a review from itsjavi June 12, 2026 10:11
@coderabbitai

coderabbitai Bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

This PR updates project and SDK documentation to reflect v1 feature completion. The Flutter SDK package README expands with installation instructions, quick-start examples, detailed public API documentation, and comprehensive setup/error-handling guidance. The root README status block now shows feature-complete-for-v1 state with remaining pre-GA integration-test requirements. Playground documentation is refreshed to describe real SDK behavior (connection, identity controls, local storage) instead of stub buttons. Repository layout and conventions are clarified. The planning document is removed.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'fix: updates readme and docs' is generic and uses vague phrasing that could apply to many different changes without clearly conveying the specific nature of the updates. Use a more specific title that highlights the key change, such as 'docs: update SDK documentation and remove AI plan' or 'docs: mark v1 feature-complete status and update playground instructions'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description is concise but directly related to the changeset, mentioning updates to Flutter SDK README, docs, and removal of the AI plan, which aligns with the actual changes made.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@packages/formbricks_flutter/README.md`:
- Around line 66-68: Update the README text to reflect the async return type:
change the description that currently says the static methods "return
Result<void, FormbricksError>" to state they return "Future<Result<void,
FormbricksError>>" (or similar wording like "an asynchronous Future<Result<void,
FormbricksError>>") and call out the specific methods Formbricks.setUserId,
Formbricks.setAttribute, and Formbricks.setAttributes so the docs match the
actual static Future<Result<void, FormbricksError>> signatures.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 51aed260-24dd-429c-8873-12053e64383d

📥 Commits

Reviewing files that changed from the base of the PR and between 6144afc and 432c73c.

📒 Files selected for processing (4)
  • README.md
  • apps/playground/README.md
  • docs/FLUTTER_SDK_PLAN.md
  • packages/formbricks_flutter/README.md
💤 Files with no reviewable changes (1)
  • docs/FLUTTER_SDK_PLAN.md

Comment thread packages/formbricks_flutter/README.md Outdated

@itsjavi itsjavi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thanks! I added some comments for more clarity

Comment thread packages/formbricks_flutter/README.md Outdated
Comment thread packages/formbricks_flutter/README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@sonarqubecloud

Copy link
Copy Markdown

@itsjavi itsjavi merged commit 153d27e into main Jun 12, 2026
10 checks passed
@itsjavi itsjavi deleted the fix/update-readme branch June 12, 2026 13:41
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