fix(docs): derive collection artifact counts from YAML at build time#1275
Merged
WilliamBerryiii merged 6 commits intomainfrom Apr 6, 2026
Merged
fix(docs): derive collection artifact counts from YAML at build time#1275WilliamBerryiii merged 6 commits intomainfrom
WilliamBerryiii merged 6 commits intomainfrom
Conversation
- replace fs/path usage in collectionCards.ts with pure resolver fns - count YAML paths in docusaurus.config.js via customFields - pass counts to components via useDocusaurusContext - add useDocusaurusContext mock and jest.config.js mapping 🔧 - Generated by Copilot
- move fs/path counting to docusaurus.config.js via customFields - replace hardcoded artifacts in collectionCards.ts with resolver fns - add gitlab, jira, and rai-planning collections - add useDocusaurusContext mock and jest.config.js mapping - add npm run docs:test to PR template and contributing guides 🔧 - Generated by Copilot
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1275 +/- ##
==========================================
- Coverage 87.63% 87.62% -0.02%
==========================================
Files 61 61
Lines 9328 9328
==========================================
- Hits 8175 8174 -1
- Misses 1153 1154 +1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Advisory review, this PR is from a maintainer. Findings are informational only.
Review Overview
This PR cleanly eliminates the manual artifact-count maintenance burden in the Docusaurus collection cards by reading YAML manifests at build time. The architecture — separating static collectionCardDefinitions from dynamic resolveCollectionCards/resolveMetaCollections resolvers, injecting counts via customFields, and cross-validating with independent YAML reads in tests — is well-designed and idiomatic for Docusaurus. The documentation updates are consistent and the test infrastructure (mock + updated test) is correct.
Three minor advisory observations are left as inline comments.
Issue Alignment
✅ PR links Fixes #1248 and Fixes #1249. Based on the description, both issues relate to the manual-count maintenance problem. The changes directly address this by deriving counts automatically. Three previously missing collections (gitlab, jira, rai-planning) are added to the count list, which appears consistent with fixing a gap.
No scope creep detected.
PR Template Compliance
CollectionCardDefinition interface, two new exported resolver functions, a new mock, and build configuration additions. "Documentation update" alone does not accurately describe these changes. A "New feature" checkbox (or at minimum a note under "Other") would better reflect the nature of the code refactor.
All other template sections are filled in correctly. Required Automated Checks are all marked as passed.
Coding Standards
✅ Changed TypeScript and JavaScript files do not fall under any instruction file's applyTo patterns in this repository (instructions cover .ps1, .sh, .py, .cs, .rs, .tf, .bicep, and markdown). No convention violations detected against the applicable instruction files.
Markdown documentation changes (.md files) follow the markdown conventions — no heading skips, proper frontmatter, and concise additions.
Code Quality
Three advisory observations (inline):
index.tsxline 13 — Unsafeascast oncustomFields.collectionCountsbypasses theunknowntype from Docusaurus's typing. A nullish-coalescing fallback would prevent a hard crash if the field is absent.collectionCards.tsline 101 —?? 0silently swallows name mismatches betweencollectionCardDefinitionsandcollectionNamesindocusaurus.config.js. Test coverage mitigates this, but a dev-modeconsole.warnwould surface the issue earlier in the contribution loop.docusaurus.config.jsline 14 —fs.readFileSyncthrows a genericENOENTon a missing YAML. A descriptive error message naming the offending collection would improve DX during collection renames or additions.
No bugs, security issues, breaking changes, or resource leaks detected.
Action Items
These are informational suggestions only (advisory mode). No changes are required for merge:
- Consider adding "New feature" to the Type of Change checkboxes to accurately reflect the code refactoring.
- Optionally harden the type assertion in
index.tsxand the error message indocusaurus.config.jsper the inline suggestions.
Note
🔒 Integrity filter blocked 2 items
The following items were blocked because they don't meet the GitHub integrity level.
- #1248
issue_read: has lower integrity than agent requires. The agent cannot read data with integrity below "approved". - #1249
issue_read: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
To allow these resources, lower min-integrity in your GitHub frontmatter:
tools:
github:
min-integrity: approved # merged | approved | unapproved | none…L error - add optional chaining and nullish coalescing for collectionCounts cast - wrap readFileSync in try/catch with actionable error on missing manifest 🛡️ - Generated by Copilot
WilliamBerryiii
approved these changes
Apr 3, 2026
rezatnoMsirhC
approved these changes
Apr 6, 2026
This was referenced Apr 6, 2026
WilliamBerryiii
pushed a commit
that referenced
this pull request
Apr 24, 2026
## 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaced hardcoded artifact counts in the Docusaurus collection cards with build-time derivation from collection YAML manifests. Every time a skill, agent, or prompt was added to a collection,
collectionCards.tsrequired a manual count update that could silently break the site. The counts are now computed automatically fromcollections/*.collection.ymlduring the Docusaurus build.Contributing documentation and the PR template were updated to include
npm run docs:testas a required validation step so contributors know to verify counts after collection changes.Description
Build-Time Artifact Count Derivation
countYamlPaths()in docusaurus.config.js to read eachcollections/*.collection.ymland count- path:entries, exposing the result map throughcustomFields.collectionCountsartifactsintegers from the 12 card definitions in collectionCards.ts and introduced theCollectionCardDefinitioninterface that separates static metadata from dynamic countscollectionCardsandmetaCollectionsexports with pure resolver functionsresolveCollectionCards(counts)andresolveMetaCollections(counts)that accept a counts record at runtimecollectionCountsfromuseDocusaurusContext()and pass them throughresolveCollectionCards()wrapped inuseMemoTest Infrastructure
useDocusaurusContextmock returning emptycollectionCountsfor Jest component testsmoduleNameMappercollectionCardDefinitions,resolveCollectionCards, andresolveMetaCollectionsexportscountYamlPaths()to module scope for reuse across test suitesDocumentation and PR Template
npm run docs:testto the Required Automated Checks section in the PR templatenpm run docs:testafter collection manifest updatesnpm run docs:testto the automated validation command list in skills.mdRelated Issue(s)
Fixes #1248
Fixes #1249
Type of Change
Code & Documentation:
Infrastructure & Configuration:
AI Artifacts:
prompt-builderagent and addressed all feedback.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md).github/skills/*/SKILL.md)Other:
.ps1,.sh,.py)Testing
fs.readFileSyncruns at build time only, not in the browser bundle.lint:md,spell-check,lint:frontmatter,validate:skills,lint:md-links,lint:ps,plugin:generate,docs:test.Checklist
Required Checks
AI Artifact Contributions
/prompt-analyzeto review contributionprompt-builderreviewRequired Automated Checks
The following validation commands must pass before merging:
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run validate:skillsnpm run lint:md-linksnpm run lint:psnpm run plugin:generatenpm run docs:testSecurity Considerations
Additional Notes
countYamlPaths()regex (^\s*- path:) is consistent with the YAML structure used across all collection manifests.collectionCardDefinitionslists 12 collections;docusaurus.config.jscounts 13 (includeshve-core-allfor the meta-collection).