Skip to main content

Pergamum Pulse Document Register

1. Purpose

This Register defines the enumerable document corpus that constitutes the governed Pergamum Pulse documentation set.

It replaces the informal discoverability function previously provided by layout.mdx.

layout.mdx is not part of this Register and SHALL NOT be treated as canonical documentation.

The Register exists so that conformance to Pergamum Pulse can be evaluated against an explicit, machine-resolvable corpus rather than an implicit folder layout.

2. Authority

PP-KDMF governs the Pergamum Pulse framework.

This Register SHALL enumerate each governed framework part, standard, specification, profile, operations design and registry-governance document belonging to Pergamum Pulse.

Document metadata remains authoritative in each document's Constitutional Header. This Register is the canonical corpus-membership register and SHALL NOT silently override a member document's own identity or version.

Where the Register disagrees with a member document, VW-DL SHALL emit a corpus-integrity finding and the discrepancy SHALL be resolved explicitly.

3. Registered Documents

IDTitleTypeVersionStatusGoverned byImplements
PP-CCPSPergamum Pulse Change Candidate and Projection Specificationspecification0.1.0draftPP-KDMF, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS
PP-DREGPergamum Pulse Document Registerregistry0.1.0draftPP-KDMFPP-KDMS
PP-HKCPPergamum Pulse HECATE Knowledge Conformance Profileprofile0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS
PP-IWCODPergamum Pulse Ingest Workbench and Curator Operations Designoperational-design0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS, PP-KORS, PP-KAS, PP-SMCS, PP-RLCPS, PP-CCPS, PP-REAPP, PP-HKCP
PP-KASPergamum Pulse Knowledge Assertion Specificationspecification0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS
PP-KDMFPergamum Pulse Knowledge Document and Metadata Frameworkframework1.0.0draftZYZ-CR-4
PP-KDMF-2Pergamum Pulse Knowledge Document and Metadata Framework 2framework1.0.0draftZYZ-CR-4
PP-KDMF-3Pergamum Pulse Knowledge Document and Metadata Framework 3framework1.0.0draftPP-KDMF
PP-KDMF-4Pergamum Pulse Knowledge Document and Metadata Framework 4framework1.0.0draftPP-KDMF
PP-KDMF-5Pergamum Pulse Knowledge Document and Metadata Framework 5framework1.0.0draftPP-KDMF
PP-KDMSPergamum Pulse Knowledge Document Metadata Specificationstandard0.2.0draftPP-KDMF
PP-KORSPergamum Pulse Knowledge Object and Relationship Specificationspecification0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS
PP-MPSPergamum Pulse Metadata Profile Specificationspecification0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS
PP-REAPPPergamum Pulse Retrieval, Embedding and AI Processing Profileprofile0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS
PP-RLCPSPergamum Pulse Rights, Licensing, Citation and Publication Specificationspecification0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-5PP-KDMS
PP-SMCSPergamum Pulse Semantic Mapping and Crosswalk Specificationspecification0.1.0draftPP-KDMF, PP-KDMF-2, PP-KDMF-3, PP-KDMF-4, PP-KDMF-5PP-KDMS
PP-SRAGPergamum Pulse Schema Registry Architecture and Governancearchitecture-and-governance0.1.0draftPP-KDMFPP-KDMS

4. Corpus Membership Rules

A Pergamum Pulse document SHALL be registered here before it is treated as part of the canonical Pergamum Pulse corpus.

Each registered document SHALL declare:

  • stable document ID;
  • semantic ID;
  • title;
  • document type;
  • version;
  • lifecycle status;
  • canonical source file;
  • applicable OMR Module lineage;
  • governing framework relationship;
  • implemented contracts where applicable;
  • normative references where applicable.

A document SHALL NOT be considered canonical merely because it exists below content/standards/pergamum-pulse.

5. Dependency Semantics

The Register preserves three different dependency semantics:

  • governed_by identifies the framework authority governing the document;
  • implements identifies a normative contract implemented by the document;
  • references identifies material normative or architectural dependencies.

These relationships SHALL NOT be collapsed into one generic dependency list.

6. Machine-Readable Projection

The machine-readable companion artefact is:

config/system/pergamum-pulse/document-register.json

The JSON projection SHOULD be generated or validated from this Register and the member Constitutional Headers.

A production implementation SHOULD preserve:

  • source Git commit;
  • source digest;
  • registry version;
  • generation timestamp;
  • validation receipt.

7. VW-DL Corpus Integrity Rules

VW-DL SHALL support at least:

RuleRequirement
PP-DOC-001Every canonical Pergamum Pulse MDX document resolves in the Document Register
PP-DOC-002Every Register entry resolves to exactly one canonical source file
PP-DOC-003Registered document ID matches member frontmatter id
PP-DOC-004Registered version matches member frontmatter version
PP-DOC-005Registered status matches member frontmatter status
PP-DOC-006source_file resolves and is unique
PP-DOC-007Required governing relationships resolve
PP-DOC-008Deleted or retired documents are explicitly removed, deprecated or historically retained according to policy
PP-DOC-009Unregistered documents SHALL NOT silently enter downstream canonical indexing or generation
PP-DOC-010Register membership changes produce a governed diff and validation finding set

8. Register Evolution

Adding, renaming, superseding, deprecating or removing a Pergamum Pulse document SHALL update this Register in the same governed change.

The Register SHALL preserve historical releases.

The published registry artefact SHALL be immutable per released version.

9. Foundational Principle

A governed corpus must be enumerable.

Pergamum Pulse SHALL be able to answer, deterministically, which documents constitute its framework and which versions of those documents participate in a given conformance baseline.

GitHub RepoRequest for Change (RFC)