fix: updates readme and docs#12
Conversation
WalkthroughThis 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)
✅ Passed checks (4 passed)
✏️ 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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (4)
README.mdapps/playground/README.mddocs/FLUTTER_SDK_PLAN.mdpackages/formbricks_flutter/README.md
💤 Files with no reviewable changes (1)
- docs/FLUTTER_SDK_PLAN.md
itsjavi
left a comment
There was a problem hiding this comment.
thanks! I added some comments for more clarity
|



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