feat(docs): add extension collections overview and integrate into getting started flow#950
Conversation
katriendg
left a comment
katriendg
left a comment
There was a problem hiding this comment.
Thanks for putting this together, @PratikWayase! The collections overview page and cross-linking are a solid start. I have a few items to address before we can merge.
Unrelated changes — please remove
This PR includes a file that aren't part of #859 and should be submitted separately:
.github/workflows/weekly-security-maintenance.yml — Adding stale SHA issue auto-creation (64 new lines) is a workflow/security change with no connection to #859. This needs its own PR with appropriate review.
Missing items from the acceptance criteria in #859
The issue specifies several requirements that aren't addressed yet:
- Expandable or linked descriptions per collection — The table is a good start, but #859 asks for each collection to have an expandable description (or link) showing the specific agents and capabilities included. Currently it's just a flat table row.
- Maturity status indicators — Design Thinking should be marked Preview and Experimental should be marked Experimental, per the implementation notes in the issue.
- Homepage hero section CTA — The issue proposes an update to
docs/docusaurus/src/pages/index.tsxfor a hero section install CTA. This file wasn't touched. - Hub card destination — The new hub card links directly to the marketplace, but the issue asks for a link to the collections overview page (or both marketplace and collections overview), so users can compare bundles before installing.
Code quality items
VsCodeExtensionIconformatting — The component has inconsistent quote styles (single vs double), irregular indentation, and spacing that doesn't match the existing icon components in the file. Please align with the style ofDesignThinkingIconand others already inIcons/index.tsx.- SVG gradient bug —
offset="100"on the last gradient stop should beoffset="100%". collections.mdfrontmatter — Theauthorfield uses lowercasepratik wayase; please use proper casing.- Missing trailing newline —
collections.mdis missing a final newline. - Hardcoded artifact counts — The issue notes that counts should be verified against
collections/*.collection.yml. Please double-check these are accurate as of the currentmainbranch.
Summary
Please:
- Remove the two unrelated file changes and submit them as separate PRs
- Address the missing acceptance criteria items listed above
- Fix the code quality items
Happy to re-review once these are addressed!
|
Thanks for the detailed review, @katriendg! So far, I’ve focused on improving the collections overview page. I’ve added expandable sections to better surface the agents and capabilities within each collection. I also noticed that only the hve-core marketplace link is working. The other collection links (e.g., ADO, etc.) are returning 404 errors when using URLs like: Could you confirm whether these extensions are not published yet, or if I should be using a different naming convention for the marketplace links? The remaining items (maturity indicators, homepage CTA, hub card updates, and code quality fixes) are still pending I’ll address those next. Also noted on the unrelated workflow file I’ll remove it and raise a separate PR for that. Please let me know if the current approach for the collections page looks good and how I should handle the marketplace links. 
|
|
Thanks @PratikWayase, I believe your expandable collections look nicely! For the extensions, maybe we have a broken link somewhere, but all current collections are available and published: So the link for ADO should be https://marketplace.visualstudio.com/items?itemName=ise-hve-essentials.hve-ado, we may have had a rename at some point. The latter is the working and correct link. |
WilliamBerryiii
force-pushed
the
feat/collections-overview-docs
branch
from
5aaa7b4 to
d7ada10
Compare
|
Thank you for this documentation contribution, @PratikWayase! Your collections overview page and the VS Code Extension hub card are great additions to the getting started experience. We pushed a few enhancements to your branch that build on your work:
Your original structure, hub card, and icon design are all preserved. We appreciate the time and care you put into this — documentation contributions make the project more accessible for everyone. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #950 +/- ##
==========================================
- Coverage 87.72% 87.71% -0.02%
==========================================
Files 61 61
Lines 9320 9320
==========================================
- Hits 8176 8175 -1
- Misses 1144 1145 +1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
WilliamBerryiii
force-pushed
the
feat/collections-overview-docs
branch
from
d7ada10 to
1355505
Compare
|
Thanks for the additions @WilliamBerryiii! |
bindsi
left a comment
bindsi
left a comment
There was a problem hiding this comment.
Thanks for your contribution. LGTM!
## Pre-Release 3.3.101 ### ✨ Features - add removed maturity tier and retire owasp-docker (#1444) - add evaluation dataset creator (#1279) - align RAI planner with guide, remove scoring, improve UX (#1287) - add PSGallery staleness check and BOM cleanup (#1379) - ISA-95 network planner agent (#1177) - auto-generate collection.md with maturity filtering (#1316) - add folder-consistency check and standardize WARN outp… (#1350) - add synth-data-generate prompt to data-science collection (#1419) - add canonical deck workflow and customer-card rendering for design thinking (#1413) - add Figma MCP integration for DT artifact export (#1222) - introduce `owasp-docker` (#1245) - replace hve-core-specific references with portable discovery-based language (#1335) - introduce `owasp-cicd` (#1246) - add secure-by-design knowledge skill (#1223) - introduce `owasp-infrastructure` (#1244) - introduce `owasp-mcp` (#1207) - add OutputPath parameter to Invoke-LinkLanguageCheck.ps1 (#1229) - add -OutputPath parameter to Validate-SkillStructure.ps1 (#1225) - add maintainer-only skip-review label guard (#1293) - add extension collections overview and integrate into getting started flow (#950) - add agentic workflows for automated issue triage, implementation, PR review, dependency review, and doc-staleness detection (#1219) - consolidate package-lock.json version sync into Update-VersionFiles.ps1 (#1240) - add standards code review agent and full review orchestrator (#1174) - standardize pytest-mock as Python mocking framework (#1170) - add Jira backlog workflows and Jira/GitLab skills (#978) - add centralized version bump script and supply-chain attestation (#1183) ### 🐛 Bug Fixes - pin PowerShell-Yaml to 0.4.7 across all install sites (#1378) - close fork-PR/workflow-file-PR secret-strip gap and normalize upload-artifact version (#1421) - replace stream-based lookahead with array indexing in list-changed-files.sh (#1376) - centralize ISO 8601 timestamp regex in CIHelpers (#1343) - update stale documentation date in release-process.md (#1363) - pin basic-ftp to 5.3.0 to resolve GHSA-rp42-5vxx-qpwr (#1374) - add bot filter to dependency PR review workflow (#1362) - resolve pip-audit findings in powerpoint, gitlab, and jira skill lock files (#1360) - standardize Timestamp JSON key casing across all lint result files (#1314) - add synchronize trigger to PR Review workflow (#1323) - standardize timestamp in Validate-SkillStructure.ps1 to use Get-StandardTimestamp (#1280) - add parallel subagent dispatch and structured JSON contracts to code-review-full (#1304) - standardize timestamp in SecurityHelpers.psm1 to use Get-StandardTimestamp (#1284) - standardize timestamps in Test-DependencyPinning.ps1 and SecurityClasses.psm1 (#1282) - derive collection artifact counts from YAML at build time (#1275) - standardize timestamp in FrontmatterValidation.psm1 to use Get-StandardTimestamp (#1285) - standardize timestamp in Markdown-Link-Check.ps1 to use Get-StandardTimestamp (#1283) - escape hyphens in Mermaid diagram on Collections page (#1262) - add summary timestamp to PSScriptAnalyzer output (#1211) - fix plugin compatibility and robustness for coding-standards code review agents (#1289) - standardize timestamp in Test-CopyrightHeaders.ps1 to use Get-StandardTimestamp (#1278) - standardize timestamp in Invoke-YamlLint.ps1 to use Get-StandardTimestamp (#1270) - standardize timestamp in Invoke-LinkLanguageCheck.ps1 to use Get-StandardTimestamp (#1264) - fix dependency-review path filters and sparse-checkout cone mode (#1259) - replace invalid bare tool names with official tool identifiers (#1198) - fix broken links and remove orphaned reference in code review docs (#1257) - exclude Python env dirs from skill validation warnings (#1255) - pin happy-dom and serialize-javascript to resolve Dependabot vulnerabilities (#1253) - remove Mermaid diagram and add missing collection cards (#1247) - disable MCP servers by default to prevent token limit errors (#1144) - sync package-lock.json after pre-release version bump (#1236) - separate mermaid node declarations and add dynamic diagram generation with tests (#1215) - replace anchor links in meeting-analyst with bold text references (#1201) - remove recursive symlinks in jira and gitlab skill directories (#1233) - validate-installation scripts now check .github/skills directory (#1010) (#1206) - resolve npm audit vulnerabilities via dependency overrides (#1200) - add post-release triggers to scorecard workflow (#1186) - add missing .md extensions to relative links in agent documentation (#1180) ### 📚 Documentation - broaden Security Review description beyond OWASP (#1385) - document maintainer advisory mode and skip-review label guard (#1386) - document ExcludePaths/OutputPath for Invoke-LinkLanguageCheck (#1383) - CLI getting-started: clarify plugin install commands as alternatives (-all vs base) (#1251) ### ♻️ Refactoring - align agent and prompt folder names to collection identifier (#1210) ### 🔧 Maintenance - pin PSScriptAnalyzer to 1.25.0 and sync stale workflow version comments (#1389) - bump lxml from 6.0.2 to 6.1.0 in /.github/skills/experimental/powerpoint (#1424) - bump @vscode/vsce from 3.7.1 to 3.9.1 in the npm-dependencies group (#1390) - bump the github-actions group across 1 directory with 7 updates (#1391) - bump follow-redirects from 1.15.11 to 1.16.0 in /docs/docusaurus (#1356) - upgrade Node.js from 20 to 24 and bump cspell to v10 (#1353) - bump basic-ftp from 5.2.0 to 5.2.1 (#1324) - update github/gh-aw-actions requirement to 536ea1bad8c6715d098a9dc1afea8d403733acfe in the github-actions group across 1 directory (#1298) - update security instruction attributions and compliance (#1294) - bump the npm-dependencies group with 2 updates (#1297) - pre-release 3.3.41 (#1252) - streamline RAI Planner phase structure and documentation (#1273) - bump happy-dom from 20.8.8 to 20.8.9 in /docs/docusaurus (#1237) - pre-release 3.3.27 (#1191) - bump pygments from 2.19.2 to 2.20.0 in /.github/skills/gitlab/gitlab (#1234) - bump path-to-regexp from 0.1.12 to 0.1.13 in /docs/docusaurus (#1226) - bump the github-actions group with 4 updates (#1231) - add missing folders and alphabetize location lists (#1193) - bump brace-expansion (#1224) - bump handlebars from 4.7.8 to 4.7.9 in /docs/docusaurus (#1217) - bump brace-expansion from 5.0.3 to 5.0.5 in /docs/docusaurus (#1213) - pre-release 3.3.10 (#1187) - bump markdownlint-cli2 from 0.21.0 to 0.22.0 in the npm-dependencies group (#1175) - bump the github-actions group with 3 updates (#1176) - pre-release 3.3.1 (#1165) --- *Managed automatically by pre-release workflow.* Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
5 participants
Pull Request
Description
This PR improves the extension installation experience by introducing a collections overview page and integrating it into the Getting Started documentation flow.
The goal is to help users quickly understand available HVE extension bundles and choose the appropriate workflow.
Changes Included
Related Issue(s)
Closes #859
Type of Change
Code & Documentation
Testing
The documentation changes were validated by:
Commands Executed
Checklist
Required Checks
Required Automated Checks
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run validate:skillsnpm run lint:md-linksnpm run lint:psnpm run plugin:generate(not applicable)Security Considerations
Additional Notes
This change focuses on improving discoverability of extension collections and integrating them into the installation and Getting Started workflow, supporting the simplified extension install experience described in Issue #859.