Category: Design

Non-normative material A proposal describes behaviour that may not exist. Current behaviour is defined by the contracts, accepted decisions, implementation, and owning checkers. Never use a proposal as a configuration reference. This section is the …

Evidence, not a contract Research records what was measured, with which inputs and tool versions. Results may explain a decision, but they do not override the current contracts or implementation. Research belongs in the public Design tree when …

OINK 1.0.0 contract This section publishes the maintainer contracts released with OINK 1.0.0, with Hugo Extended 0.160.1 as the compatibility floor. Continuous tests use one pinned Hugo Extended toolchain, currently 0.165.0; the floor is not a …

Accepted rationale A decision explains why OINK chose one compatible design over another. The five contracts above it remain the normative description of current behaviour; implementation and owning checkers remain the executable facts. OINK used to …

OINK 1.0.0 contract This is the migration contract released with OINK 1.0.0. This page is the canonical English source; its Chinese peer is maintained beside it in content/docs/design/. This is source and configuration guidance, not a release …

OINK 1.0.0 contract This is the landing-page contract released with OINK 1.0.0. This page is the canonical English source; its Chinese peer is maintained beside it in content/docs/design/. Shared rules live in the architecture and component …

Decision The two JSON Schemas under schema/ are projected by bin/generate-config-schema.py from the theme’s hugo.yaml and the template read-point scan; hand edits cannot survive CI. The schema is a read-only projection of the existing authorities, …

Draft proposal with implemented publication tooling The opt-in BookManifest, the generic EPUB and PDF runners and their artifact validation are released, and the normative account of them is in Architecture. No build publishes either file on its …

OINK 1.0.0 contract This is the shell and navigation contract released with OINK 1.0.0. This page is the canonical English source; its Chinese peer is maintained beside it in content/docs/design/. Authorities and navigation Concern Authority Global …

Decision Prefer a native Markdown form when Goldmark can preserve the intended semantics. Keep a shortcode only when it provides a capability the native form cannot express. Add a content scenario by extending an existing shell and data model, not …

Implemented; ships with OINK 0.8.0 Accepted on 2026-08-27 after resolving every open decision. Both outputs – the per-top-level-section LLMSFULL bundles and the NAVJSON navigation tree at the language root – are implemented on the theme’s main …

Review snapshot, not a new contract This page records evidence collected against github.com/pgsty/oink and its integration site on 2026-08-26. It changes no API and does not mean that any recommendation below is implemented. Current Design …

Partially implemented M1 (the shared media-result contract) and M2 (Landing resource metadata) are implemented on the theme’s main branch, and M3 is resolved as option 2: processing stays exclusively on native Markdown images, and the full fig …

Dated corpus snapshot These counts describe the repositories inspected in August 2026. They are evidence for design choices, not live product metrics or compatibility promises. Corpus The authoring survey scanned the content/ trees of eleven OINK …

Decision OINK keeps Hugo’s native keys and useful Docsy-compatible keys in place, places theme presentation and behaviour under params.ui.*, and exposes a matching top-level front-matter key for a page override. It does not add a params.oink.* tree …

OINK 1.0.0 contract This is the component contract released with OINK 1.0.0. This page is the canonical English source; its Chinese peer is maintained beside it in content/docs/design/. Tutorials and exhaustive examples belong in the reader-facing …

G1 implemented; G2/G3 remain draft On 2026-08-27 every G1 open decision was resolved and G1 (static backlinks) was accepted. It is implemented on the theme’s main branch and ships with OINK 0.8.0. The local and global graphs (G2/G3) stay draft …

Verified snapshot These probes produced byte-identical relevant output on Hugo Extended 0.160.1 and 0.164.0. They explain OINK’s native component forms; the current component contract remains authoritative. Method The probe used a minimal Hugo site …

Decision OINK does not call Hugo’s errorf. Invalid author or site input emits a warning and either uses a documented safe fallback or omits the invalid fragment. Release and deployment builds use --panicOnWarning, so the same warning remains a hard …

OINK 1.0.0 contract This is the architecture contract released with OINK 1.0.0. This page is the canonical English source; its Chinese peer is maintained beside it in content/docs/design/. Repository and assembly The repository root is a Hugo Module …