Skip to content

docs(contributing): document registry fields - #255

Open
terminalchai wants to merge 1 commit into
nastaso:mainfrom
terminalchai:docs/certification-registry-28
Open

terminalchai wants to merge 1 commit into
nastaso:mainfrom
terminalchai:docs/certification-registry-28

Conversation

@terminalchai

Copy link
Copy Markdown
Contributor

What does this PR do?

Adds a compact contributor reference for the certification registry. It documents the required Certification and CertDomain fields, clarifies the different purposes of examProportion and weight, and identifies the generated question-count file that contributors must not edit manually.

Why?

Contributors currently need to inspect TypeScript JSDoc to understand registry fields, especially the distinction between mock-exam proportions and official exam-guide weights.

Closes #28

How was this tested?

  • npm run check (Astro check, ESLint, and 318 Vitest tests)
  • npm run validate
  • npm run build
  • PW_PORT=4399 PW_REUSE_SERVER=0 npm run e2e (109 passed, 20 credential-dependent tests skipped)
  • git diff --check

Checklist

  • npm run build passes locally
  • npm run lint passes locally
  • npm run test passes locally
  • npm run validate passes locally
  • No new third-party dependencies

Screenshots (UI changes only)

Not applicable. This PR changes contributor documentation only.

Document the Certification and CertDomain fields, clarify the distinct purposes of examProportion and weight, and identify generated registry output.\n\nRefs nastaso#28
@terminalchai
terminalchai requested a review from nastaso as a code owner August 29, 2026 19:41
@github-actions github-actions Bot added the docs label Aug 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add a "How the certification registry works" guide for contributors

1 participant