Skip to content

docs: add npm run docs:test to PR template checklist and contributing guides #1248

@katriendg

Description

@katriendg

Problem

The Docusaurus unit tests (npm run docs:test) are not listed in the PR checklist or any contributor-facing documentation. This means contributors who add artifacts to collection manifests will not know to update docs/docusaurus/src/data/collectionCards.ts, causing CI to fail when adding new skills, agents, or prompts to collections.

Proposed Changes

1. .github/PULL_REQUEST_TEMPLATE.md

Add docs:test to the Required Automated Checks section alongside plugin:generate:

 * [ ] Plugin freshness: `npm run plugin:generate`
+* [ ] Docusaurus tests: `npm run docs:test`

2. docs/contributing/ai-artifacts-common.md — "Adding Artifacts to a Collection"

After the existing step 7 (npm run plugin:generate), add step 8:

+8. Update `docs/docusaurus/src/data/collectionCards.ts` to reflect the new artifact count
+   for the affected collection(s) and `metaCollections['hve-core-all']`, then run
+   `npm run docs:test` to verify.

3. docs/contributing/skills.md — Automated Validation section

Add docs:test to the commands list:

+npm run docs:test             # Validate Docusaurus artifact counts

Acceptance Criteria

  • PR template includes npm run docs:test in Required Automated Checks
  • docs/contributing/ai-artifacts-common.md collection registration steps include the collectionCards.ts update instruction
  • docs/contributing/skills.md Automated Validation section includes npm run docs:test
  • All three files pass npm run lint:md

Related

  • Follow-up: long-term YAML-driven count derivation (see related issue)

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions