Skip to content

README

Jump to bottom
hyiger edited this page Jul 11, 2026 · 3 revisions

README — repository maintenance

This is the source repository for the FDM Polymers wiki. Readers should start at Home; this page documents how the wiki is edited and validated.

Editing workflow

  1. Clone the wiki repository and edit locally. Web-UI edits bypass every check below — GitHub wikis cannot run Actions on wiki pushes, so validation is local-only. Prefer the clone.
  2. After any edit, run the full validation suite:
make check
  1. When a source is re-verified or a value is corrected against a live source, update the Appendix D.6 ledger and the affected row of the Source manifest. The repository commit history is the record of each pass — write commit messages accordingly.
  2. The re-verification cadence for volatile content (brand surveys, prices, availability, regulatory notes) is a rolling six months — defined in Appendix D.5.

The checks

Command Enforces
./check-source-hygiene.sh No U+00AD soft hyphens; every heading preceded by a blank line
python3 check-cross-references.py Every §N.M, Table, Chapter, and Appendix reference resolves; every wiki link and anchor (cross-page and same-page, with GitHub duplicate-slug suffixing) resolves; the Source manifest covers exactly the volume's table inventory
python3 scan-brand-mentions.py --verify The Appendix C brand index matches the counting policy stated in its intro, as computed from the full text (policy carve-outs are encoded and commented in the script)

make check runs all three. python3 scan-brand-mentions.py (no flag) prints the computed brand→chapter lists for regenerating Appendix C; --raw prints the exhaustive context listing for curation.

Optional pre-push hook

make install-hooks

installs hooks/pre-push into .git/hooks/, so git push refuses to publish a state that fails make check.

Layout notes

  • Every .md file is a wiki page except _Sidebar.md (navigation) — keep non-page tooling in non-Markdown files.
  • FDM-Wiki-Review-Report.md is a review artifact excluded by name from all three checks.
  • Scripts assume the repo root as the working directory.

FDM Polymers — A Technical Reference

Clone this wiki locally