Skip to content

site: the PFS feature pages — concept + .pfs language reference (pubid#706) - #25

Merged
ronaldtse merged 1 commit into
mainfrom
docs/pfs-feature
Nov 12, 2026
Merged

ronaldtse merged 1 commit into
mainfrom
docs/pfs-feature

Conversation

@ronaldtse

Copy link
Copy Markdown
Contributor

Summary

Ships the website pages for PFS — the PubID Format Schema (.pfs), the direction adopted in pubid/pubid#706 (Phase 1 compiler + doi spike, Phase 2 etsi + module library):

  • Concept page — /concepts/pfs (src/content/concepts/pfs.md, prose-only per the concept-page rule): why one data file compiles to the Ruby and TypeScript flavors, the corpus-is-the-spec philosophy, the tier model in plain prose (27 of 44 flavors v1-expressible, ~43.8k fixtures; ISO/IEC schemes stay coded while their inner formats ship as modules), the module library for national adoptions (the DIN/BS/NF EN-ISO story), the Conormis wizard connection (#406, no link — the repo is private and the link checker would 404), and the byte-parity acceptance gate.
  • Reference page — /library/pfs (src/content/library/pfs.md, reference-shaped like the pubid-URN-scheme page): the .pfs sections, the template language (presence guards, alternates), the module library with the composition rules, the compile-time validations (each rejection cites the rule), versioning (pfs: 1, fail-closed), compiling, the both-engines artifact story, the parity-harness pattern and the v1 boundaries.
  • Registration — pfs added to the concepts order (src/pages/concepts/index.astro, between Corpus and URN) and the reference page added to the library index's reading list.

Executed snippets (the method)

Every snippet on the reference page was run against the real toolchain before shipping:

  • the Wxyz worked example from #706 §2, expressed in the implemented v1 language — scripts/pfs compile green (3 positives / 3 negatives verified against the baked artifact, checksum quoted from the run);
  • the DIN module composition (iso.inner + en.overlay + national.prefix + supplements.core) — compiles green (2 positives / 3 negatives), mirroring the shipped cen.pfs port;
  • the compile commands (workflow-pin form and --ruby-out form) — executed verbatim, --ruby-out emits the 9-file flavor module;
  • the shipped doi / etsi / calconnect / cen definitions compile green on pubid-grammar main (4+5, 11+8, 7+5, 3+4);
  • the parity harnesses run green on pubid main: spec/pubid/doi_pfs + spec/pubid/etsi_pfs, 90 examples, 0 failures.

Cross-links: concept page → reference page → pubid#706 + definitions/README.md + definitions/modules/; reference page → the parity harness on pubid main and pubid-ts#170 (the TS-side doi_pfs).

Test plan

  • npx astro check — 0 errors, 0 warnings
  • npm run build — 358 pages built (baseline 356 + the two new pages)
  • npx vitest run — 435 passed
  • lychee over dist/ — 745 unique links, 0 errors
  • concepts index renders the PFS entry; library index lists the reference page

…d#706)

The concept page (prose-only) covers why one data file compiles to both
engines, the module library for national adoptions, the wizard
connection, the tier model and the byte-parity acceptance gate; the
library reference walks the .pfs surface (sections, template language,
module composition, compile-time validations, versioning, the parity
harness) with every example compiled green against the real toolchain
(scripts/pfs, parsanol 1.3.126): the Wxyz worked example from #706 §2,
a DIN module composition, and the shipped doi/etsi/calconnect/cen
definitions. Registered in the concepts order and the library index.
@ronaldtse
ronaldtse merged commit dc22871 into main Nov 12, 2026
1 check passed
@ronaldtse
ronaldtse deleted the docs/pfs-feature branch November 12, 2026 16:11
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