Skip to content

docs: add Extension Comparison Guide for community extensions#1897

Open
imviancagrace wants to merge 5 commits intogithub:mainfrom
imviancagrace:docs/extension-comparison-guide
Open

docs: add Extension Comparison Guide for community extensions#1897
imviancagrace wants to merge 5 commits intogithub:mainfrom
imviancagrace:docs/extension-comparison-guide

Conversation

@imviancagrace
Copy link
Contributor

@imviancagrace imviancagrace commented Mar 18, 2026

Description

Updates the README.md. Added two new columns, Category and Effect, in the community extension table.

Testing

N/A — documentation-only change. Verified all markdown links and table formatting render correctly.

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (describe below)

Used Cursor to analyze the 19 community extensions in catalog.community.json for overlapping functionality, draft the comparison guide, and iterate on the format. All content was reviewed and directed by the author.

@imviancagrace imviancagrace requested a review from mnriem as a code owner March 18, 2026 17:19
Copilot AI review requested due to automatic review settings March 18, 2026 17:19
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new documentation artifact to help users compare community extensions by category and purpose, and updates the extension publishing workflow docs to keep that guide maintained over time.

Changes:

  • Add extensions/EXTENSION-COMPARISON-GUIDE.md with categorized tables covering all community extensions.
  • Update extensions/README.md to reference the new guide and require updating it during extension submissions.
  • Update extensions/EXTENSION-PUBLISHING-GUIDE.md to include the comparison guide in the publishing steps/checklist and git add command.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
extensions/README.md Links to the comparison guide from the community extensions section and adds it to the submission requirements.
extensions/EXTENSION-PUBLISHING-GUIDE.md Adds a dedicated step + checklist item to update the comparison guide when publishing an extension.
extensions/EXTENSION-COMPARISON-GUIDE.md New quick-reference guide comparing extensions across Docs/Code/Integrations/Visibility categories.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Collaborator

@mnriem mnriem left a comment

Choose a reason for hiding this comment

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

Love the idea, but I rather would see an additional column in the README.md that uses a simple tag cloud (e.g. docs, code, integration, process). Otherwise we would have to keep these in sync.

@imviancagrace
Copy link
Contributor Author

resolved your comment. thank you! @mnriem

@mnriem mnriem requested a review from Copilot March 18, 2026 18:46
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the community extensions documentation to help readers quickly understand what each community extension does and how it impacts a project.

Changes:

  • Adds “Category” and “Effect” definitions for community extensions.
  • Expands the community extensions table with new “Category” and “Effect” columns.
  • Updates each listed extension row to include values for the new columns.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mnriem mnriem self-requested a review March 18, 2026 19:38
Copy link
Collaborator

@mnriem mnriem left a comment

Choose a reason for hiding this comment

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

Please resolve conflicts

…ison-guide

Made-with: Cursor

# Conflicts:
#	extensions/README.md
Copilot AI review requested due to automatic review settings March 18, 2026 19:51
@imviancagrace imviancagrace force-pushed the docs/extension-comparison-guide branch from 325d8a9 to 0fcb799 Compare March 18, 2026 19:51
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the community extensions documentation in extensions/README.md to help readers compare extensions by adding a lightweight classification (“Category”) and file-modification impact (“Effect”).

Changes:

  • Add “Category” and “Effect” definitions above the community extensions table.
  • Expand the community extensions table from 3 columns to 5 columns (adds Category/Effect).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings March 18, 2026 19:54
@imviancagrace imviancagrace force-pushed the docs/extension-comparison-guide branch from d4f20a0 to 0fcb799 Compare March 18, 2026 19:55
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the community extensions documentation in extensions/README.md to add a lightweight comparison guide (Category/Effect) for each listed community extension.

Changes:

  • Adds definitions for new Category and Effect fields to help interpret the community extensions list.
  • Updates the community extensions table entries to include Category/Effect information.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@imviancagrace
Copy link
Contributor Author

@mnriem conflicts and copilot review resolved

@mnriem mnriem requested a review from Copilot March 19, 2026 10:05
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the community extensions documentation to make the extensions/README.md community table more informative and to align contributor guidance in the publishing guide.

Changes:

  • Adds Category and Effect columns to the community extensions table in extensions/README.md, plus brief definitions for those fields.
  • Updates extensions/EXTENSION-PUBLISHING-GUIDE.md to reflect the new table row format and document the allowed Category/Effect values.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
extensions/README.md Expands the community extensions table with Category/Effect and adds a short legend explaining the new fields.
extensions/EXTENSION-PUBLISHING-GUIDE.md Updates submission instructions/snippet to include the new Category/Effect fields and defines the accepted values.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mnriem mnriem self-requested a review March 19, 2026 11:28
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.

3 participants