docs: improve package READMEs with quick start guides & detailed features#462
Merged
divyanshub024 merged 2 commits intodevfrom Mar 2, 2026
Merged
docs: improve package READMEs with quick start guides & detailed features#462divyanshub024 merged 2 commits intodevfrom
divyanshub024 merged 2 commits intodevfrom
Conversation
…res, and a new example image.
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR updates README content across examples and packages: rewrites descriptions to emphasize Server-Driven UI and Dart DSL, standardizes badges, and adds expanded run/install/Quick Start instructions and environment notes; no code or public API changes. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 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 |
Potatomonsta
approved these changes
Mar 2, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/stac_cli/README.md`:
- Around line 9-17: The README.md currently shows unsafe curl|bash and irm|iex
install examples; replace them with explicit download + integrity verification +
explicit execution instructions: for macOS/Linux update the macOS / Linux block
to download install.sh (referencing install.sh), instruct users to verify
checksum/signature, then run it with bash install.sh; for Windows replace the
PowerShell pipe example with Invoke-WebRequest to save install.ps1 (referencing
install.ps1), instruct users to verify checksum/signature, then run it with
powershell -ExecutionPolicy Bypass -File .\install.ps1; keep the steps concise
and clearly label verification before execution.
In `@packages/stac/README.md`:
- Line 151: Update the user-facing label value where it's misspelled: change the
text property currently set as 'Procced' to the correct spelling 'Proceed'
(modify the example entry with text: 'Procced' in the README). Ensure the
correction is applied to the same example key (text) so the displayed button
label reads "Proceed".
- Around line 59-64: The quick-start snippet references defaultStacOptions but
the import is commented out, causing a runtime/name error; update the example so
it runs as-is by either uncommenting the import that provides defaultStacOptions
or by showing inline/optional usage of Stac.initialize (e.g., call
Stac.initialize() without options or define defaultStacOptions in the snippet).
Ensure the README example consistently defines or imports the symbol referenced
by Stac.initialize to avoid copy/paste failure.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
assets/login.pngis excluded by!**/*.png
📒 Files selected for processing (9)
examples/counter_example/README.mdexamples/movie_app/README.mdexamples/stac_gallery/README.mdpackages/stac/README.mdpackages/stac_cli/README.mdpackages/stac_core/README.mdpackages/stac_framework/README.mdpackages/stac_logger/README.mdpackages/stac_webview/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
improve package READMEs with quick start guides & detailed features
Type of Change
Summary by CodeRabbit