refactor(stac-vscode): update the Stac Live Preview image link & version bump to 0.2.0#466
refactor(stac-vscode): update the Stac Live Preview image link & version bump to 0.2.0#466divyanshub024 merged 4 commits intodevfrom
Conversation
📝 WalkthroughWalkthroughAdds documentation and configuration for the Stac VS Code extension version 0.2.0. Changes include new documentation pages, navigation updates, version bump, and README modifications to reflect the release. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
tools/stac-vscode/README.md (1)
10-10: Pin this image to an immutable asset.Using the
devbranch for the preview image means the 0.2.0 README can silently drift later. Prefer a repo-local packaged asset or a URL pinned to a release tag/commit.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@tools/stac-vscode/README.md` at line 10, The README references the preview image via the dev-branch raw URL which is mutable; replace that reference with an immutable asset by either adding the image to the repo (e.g., tools/stac-vscode/media/stac_preview.png) and updating the markdown image tag to the repo-local relative path, or pin the raw GitHub URL to a specific release tag or commit SHA (replace the dev segment with the tag or SHA) so the image cannot drift; update the markdown image reference line accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/tools/vscode.mdx`:
- Around line 70-79: The "## Commands and shortcuts" section currently presents
a partial command table (shows `Stac: Open Preview`, `Stac: Select Preview
Screen`, `Stac: Stop Preview`, `Stac: Regenerate Catalog`) but the extension's
`package.json` registers 11 commands; either expand this table to include the
missing wrap commands from `tools/stac-vscode/package.json` (add their command
names and short descriptions) or change the introductory sentence to make it
explicit this is a subset (e.g., "Common preview and catalog commands" or
"Preview/catalog commands (subset)"); update the text near the heading and
ensure the table includes all command names exactly as they appear in
`package.json` if you choose to list them.
- Around line 87-96: The settings table omits two preview options and misstates
the default for wrap presets; add rows for stacVscode.preview.buildCommand and
stacVscode.preview.outputDirCandidates with their exact default values and short
descriptions taken from the extension manifest, and replace the
`stacVscode.wrapPresets` "All presets" default with the manifest's actual
default value (the specific preset list) so the table accurately documents
stacVscode.wrapPresets, stacVscode.preview.buildCommand, and
stacVscode.preview.outputDirCandidates.
---
Nitpick comments:
In `@tools/stac-vscode/README.md`:
- Line 10: The README references the preview image via the dev-branch raw URL
which is mutable; replace that reference with an immutable asset by either
adding the image to the repo (e.g., tools/stac-vscode/media/stac_preview.png)
and updating the markdown image tag to the repo-local relative path, or pin the
raw GitHub URL to a specific release tag or commit SHA (replace the dev segment
with the tag or SHA) so the image cannot drift; update the markdown image
reference line accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 88c16b3f-7946-45c7-97a5-3b5661c60285
📒 Files selected for processing (5)
docs/docs.jsondocs/tools/vscode.mdxtools/stac-vscode/CHANGELOG.mdtools/stac-vscode/README.mdtools/stac-vscode/package.json
Description
refactor(stac-vscode): update the Stac Live Preview image link & version bump to 0.2.0
Related Issues
Closes #
Type of Change
Summary by CodeRabbit
Documentation
Chores