docs: document native Pipeline workflows - #24
Conversation
hyochan
added
🌎 web
|
Warning Review limit reached
Next review available in: 51 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThe PR aligns Pipeline DSL documentation with final-step output typing and runtime text/metadata handoff. It adds Swift and Kotlin examples, updates native demos, documents wrapper composition, and adds contract tests for the revised guidance. ChangesPipeline DSL documentation and examples
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
packages/site/src/pipeline-docs.test.ts (1)
18-44: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winReduce coupling to exact prose and formatting.
Several assertions match rendered sentence fragments, for example
"final result type","cannot prove", and"Final-output tracking, not typed edges". Prettier controls where those sentences wrap, so a reformat or a small wording edit breaks CI without a real regression. Line 19 already needs\s+to absorb one wrap.Assert on stable anchors instead, for example the
AnchorLinkidvalues,Callouttitleprops, and code identifiers such astranslateStreamingandmodel.pipeline.The negative assertions on Line 41 and Line 43 have the same weakness in reverse.
model.proofread(inputText)passes if the variable is renamed, so the test stops guarding the intended behavior.🤖 Prompt for 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. In `@packages/site/src/pipeline-docs.test.ts` around lines 18 - 44, Reduce brittleness in the tests within pipeline-docs.test.ts by replacing exact rendered prose checks such as “final result type,” “cannot prove,” and “Final-output tracking, not typed edges” with stable documentation anchors, including AnchorLink ids, Callout title props, and code identifiers. Strengthen the negative native-example assertions to detect the actual proofread API usage regardless of input-variable renaming, while preserving the existing positive checks for translateStreaming and pipeline usage.
🤖 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/site/src/pages/home/Home.tsx`:
- Line 170: Update the sibling Swift Pipeline snippet in Home.tsx to use the
documented step types Proofread() and Translate(to:) instead of ProofreadChain()
and TranslateChain(to: "ko"), while preserving the existing pipeline structure
and example behavior.
In `@README.md`:
- Around line 90-108: Wrap the README Kotlin example containing model.summarize
and chain.run in a suspend function, following the existing suspend fun
structure used later in the document. Keep the Simple, Chain, and Custom
examples within that function so the suspend operations compile correctly.
---
Nitpick comments:
In `@packages/site/src/pipeline-docs.test.ts`:
- Around line 18-44: Reduce brittleness in the tests within
pipeline-docs.test.ts by replacing exact rendered prose checks such as “final
result type,” “cannot prove,” and “Final-output tracking, not typed edges” with
stable documentation anchors, including AnchorLink ids, Callout title props, and
code identifiers. Strengthen the negative native-example assertions to detect
the actual proofread API usage regardless of input-variable renaming, while
preserving the existing positive checks for translateStreaming and pipeline
usage.
🪄 Autofix
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: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 0454354e-3180-4b43-a959-04db917f9b1a
📒 Files selected for processing (15)
README.mdpackages/android/example/src/main/kotlin/com/locanara/example/components/pages/framework/PipelineDemo.ktpackages/android/locanara/src/main/kotlin/com/locanara/dsl/Pipeline.ktpackages/android/locanara/src/main/kotlin/com/locanara/dsl/PipelineStep.ktpackages/apple/Example/LocanaraExample/components/pages/FrameworkShowcase/PipelineDemo.swiftpackages/apple/Sources/DSL/Pipeline.swiftpackages/site/src/pages/docs/apis/pipeline.tsxpackages/site/src/pages/docs/libraries/expo.tsxpackages/site/src/pages/docs/libraries/flutter.tsxpackages/site/src/pages/docs/tutorials/index.tsxpackages/site/src/pages/docs/tutorials/pipeline.tsxpackages/site/src/pages/docs/types/index.tsxpackages/site/src/pages/docs/utils/ios.tsxpackages/site/src/pages/home/Home.tsxpackages/site/src/pipeline-docs.test.ts
1 participant
Summary
Test plan
cd packages/site && bun run typecheckcd packages/site && bun run lint(two pre-existing warnings only)cd packages/site && bun run format:checkcd packages/site && bun run test(68 tests)cd packages/site && bun run buildcd packages/apple && swift build && swift test(177 tests)cd packages/android && ./gradlew :locanara:test :locanara:build :example:assembleDebugcd scripts/agent && bun run lint:markdown && bun run checkCloses #14
Summary by CodeRabbit
Documentation
Examples
Tests