Skip to content

Update README with VS Code Marketplace link and installation notes#24

Merged
hoangsonww merged 2 commits intomasterfrom
fix/fix-docs
Apr 29, 2026
Merged

Update README with VS Code Marketplace link and installation notes#24
hoangsonww merged 2 commits intomasterfrom
fix/fix-docs

Conversation

@hoangsonww
Copy link
Copy Markdown
Owner

This pull request makes improvements to the release workflow and documentation for the VS Code extension. The main changes ensure cross-platform compatibility in the workflow by specifying the shell, and enhance the README with installation guidance and a marketplace link.

Workflow improvements:

  • Updated the Install dependencies steps in .github/workflows/release.yml to explicitly use shell: bash, ensuring that on Windows runners, Git Bash is used instead of PowerShell. This avoids parsing errors with bash-specific commands and improves cross-platform reliability. [1] [2] [3]

Documentation enhancements:

  • Added a Marketplace link and an important note to the vscode-extension/README.md, instructing users to install the Forge runtime globally before using the extension, since it is not bundled.

hoangsonww and others added 2 commits April 27, 2026 19:34
…e to README

Co-authored-by: Kailie Le <davn0376@gmail.com>
@hoangsonww hoangsonww self-assigned this Apr 29, 2026
@hoangsonww hoangsonww added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Apr 29, 2026
@hoangsonww hoangsonww added good first issue Good for newcomers feature Feature request labels Apr 29, 2026
@hoangsonww hoangsonww merged commit 0fef267 into master Apr 29, 2026
11 checks passed
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md for the VS Code extension by adding a marketplace link and a notice regarding the global installation of the Forge runtime. A review comment suggests adding an ## Installation header to ensure that internal documentation links within the extension function correctly by providing a valid anchor.

> [!TIP]
> Marketplace Link: [https://marketplace.visualstudio.com/items?itemName=hoangsonw.forge-agentic-coding-cli](https://marketplace.visualstudio.com/items?itemName=hoangsonw.forge-agentic-coding-cli).

> [!IMPORTANT]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

The extension's source code (specifically in extension.ts) contains a link to the documentation with an anchor #installation. However, the README currently lacks an Installation header, which means the link will not navigate to the correct section when clicked from the extension's warning message. Adding an ## Installation header here will fix this and provide a clear section for the installation notes.

Suggested change
> [!IMPORTANT]
## Installation
> [!IMPORTANT]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request feature Feature request good first issue Good for newcomers

Development

Successfully merging this pull request may close these issues.

1 participant