Skip to content

Conversation

Copy link

Copilot AI commented Jul 16, 2025

This PR significantly improves the installation documentation to address user questions about how to install the OpenFGA VS Code extension.

Changes Made

Enhanced README.md Installation Section

  • Added Prerequisites: Clear VS Code version requirements (1.75.0+)
  • Method 1 - Marketplace Installation: Detailed step-by-step instructions with keyboard shortcuts for different platforms
  • Method 2 - OpenVSX Registry: Enhanced explanation with context about VS Code compatible editors (VSCodium)
  • Method 3 - Manual VSIX Installation: Complete command palette instructions for manual installation
  • Added Verification Section: Steps to confirm successful installation and test functionality

Improved package.json

  • Added appropriate marketplace categories (Programming Languages, Themes, Snippets) for better discoverability

Before & After

Before: Basic installation section with just links to different sources

## Installation

You can install the OpenFGA VS Code plugin from:
- [OpenFGA on the VS Code marketplace](...)
- [OpenFGA on the OpenVSX Registry](...)
- [The VSIX releases on GitHub](...) for manual installation

After: Comprehensive installation guide with prerequisites, detailed steps for each method, and verification instructions

Benefits

  • User-friendly: Clear instructions for users of all experience levels
  • Platform-specific: Includes keyboard shortcuts for Windows/Linux/macOS
  • Comprehensive: Covers all installation scenarios including offline/air-gapped environments
  • Discoverable: Better marketplace categorization helps users find the extension
  • Verifiable: Users can confirm successful installation

The changes are minimal and focused on documentation enhancement without modifying any functional code.

Fixes #383.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 16, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: aaguiarz / name: Andrés Aguiar (fe6c1b2)
  • ✅ login: Copilot / name: copilot-swe-agent[bot] (9434ce5, fe6c1b2)

Copilot AI changed the title [WIP] Instructions on how to install the plugin Enhance installation instructions with comprehensive step-by-step guide Jul 16, 2025
Copilot AI requested a review from aaguiarz July 16, 2025 12:33
Copilot finished work on behalf of aaguiarz July 16, 2025 12:33
@aaguiarz aaguiarz marked this pull request as ready for review October 28, 2025 10:52
@aaguiarz aaguiarz requested review from a team as code owners October 28, 2025 10:52
@jarias-lfx
Copy link

/easycla

Copy link
Member

@Siddhant-K-code Siddhant-K-code left a comment

Choose a reason for hiding this comment

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

Overall looks good % non-blocking comment

Comment on lines +26 to +30
"categories": [
"Programming Languages",
"Themes",
"Snippets"
],
Copy link
Member

Choose a reason for hiding this comment

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

Can we add a category like Auth or Security (since it is related to OpenFGA)?


If you're using VS Code compatible editors (like VSCodium), you can install from:
- [OpenFGA on the OpenVSX Registry](https://open-vsx.org/extension/OpenFGA/openfga-vscode)
- [The VSIX releases on GitHub](https://github.com/openfga/vscode-ext/releases) for manual installation
Copy link
Member

Choose a reason for hiding this comment

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

I am unsure why it get removed?

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.

Instructions on how to install the plugin

4 participants