Skip to content

docs: npm run sync, citation validation, and knowledge pinning#35

Merged
Bissbert merged 1 commit into
mainfrom
docs/citation-pinning
May 12, 2026
Merged

docs: npm run sync, citation validation, and knowledge pinning#35
Bissbert merged 1 commit into
mainfrom
docs/citation-pinning

Conversation

@Bissbert
Copy link
Copy Markdown
Contributor

Summary

  • Adds a Knowledge content & citations section to the README documenting how learn content is pinned to a gemmology-knowledge release tag via src/lib/knowledge-version.ts, with a four-step bump workflow.
  • Surfaces npm run sync and npm run validate:citations in the Development quick-start (sync auto-runs in dev/build but is needed manually on tag bumps).
  • Links out to the upstream knowledge README for the full references/{cite:id} schema, and to /about/sources/ for the aggregated bibliography.

Test plan

  • Manual read-through of rendered README on the PR
  • Confirmed KNOWLEDGE_VERSION constant path is accurate
  • Confirmed all four npm scripts (sync, validate:citations, build, dev) exist in package.json

Adds a 'Knowledge content & citations' section explaining the
src/lib/knowledge-version.ts pin, the bump workflow, and how to run
npm run validate:citations. Also surfaces npm run sync in the
Development quick-start (it's auto-invoked by dev/build but needed
manually when bumping the knowledge tag).
@Bissbert Bissbert merged commit 235679f into main May 12, 2026
2 of 3 checks passed
@github-actions
Copy link
Copy Markdown

🚀 Preview deployed to: https://f872ee3c.gemmology-dev.pages.dev

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.

1 participant