Skip to content

refactor(stac-vscode): update the Stac Live Preview image link & version bump to 0.2.0#466

Merged
divyanshub024 merged 4 commits intodevfrom
dv/vscode-0.2
Mar 6, 2026
Merged

refactor(stac-vscode): update the Stac Live Preview image link & version bump to 0.2.0#466
divyanshub024 merged 4 commits intodevfrom
dv/vscode-0.2

Conversation

@divyanshub024
Copy link
Member

@divyanshub024 divyanshub024 commented Mar 6, 2026

Description

refactor(stac-vscode): update the Stac Live Preview image link & version bump to 0.2.0

Related Issues

Closes #

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Code refactor
  • Build configuration change
  • Documentation
  • Chore

Summary by CodeRabbit

  • Documentation

    • Added new "Tools" section to navigation with comprehensive VS Code extension setup and usage guide
    • Updated extension README and changelog
  • Chores

    • Released VS Code extension v0.2.0 with bug fixes and improvements

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 6, 2026

📝 Walkthrough

Walkthrough

Adds 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

Cohort / File(s) Summary
Documentation & Navigation
docs/docs.json, docs/tools/vscode.mdx
Adds new "Tools" navigation tab with "Editor Extensions" group and comprehensive VS Code extension documentation covering installation, configuration, live preview, snippets, commands, settings, and troubleshooting.
Extension Release
tools/stac-vscode/package.json, tools/stac-vscode/CHANGELOG.md, tools/stac-vscode/README.md
Version bump to 0.2.0, adds changelog entry, and updates README image reference from relative path to absolute GitHub URL.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • rahulbisht25
  • Potatomonsta

Poem

🐰✨ A new Tools tab hops into view,
With VS Code docs, shiny and new,
Version 0.2.0 takes its flight,
Extension guides polished just right! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title mentions updating the Stac Live Preview image link and version bump to 0.2.0, which are covered in the changeset, but omits the significant addition of new documentation (vscode.mdx) and navigation updates that are substantial parts of this PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch dv/vscode-0.2

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
tools/stac-vscode/README.md (1)

10-10: Pin this image to an immutable asset.

Using the dev branch 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

📥 Commits

Reviewing files that changed from the base of the PR and between ea6fadc and f37cdc4.

📒 Files selected for processing (5)
  • docs/docs.json
  • docs/tools/vscode.mdx
  • tools/stac-vscode/CHANGELOG.md
  • tools/stac-vscode/README.md
  • tools/stac-vscode/package.json

@divyanshub024 divyanshub024 merged commit c89e071 into dev Mar 6, 2026
6 checks passed
@divyanshub024 divyanshub024 deleted the dv/vscode-0.2 branch March 6, 2026 18:59
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.

1 participant