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.2.0 contract This contract describes the v1.2.0 release. Its canonical bilingual sources are in content/docs/design/. Hugo Extended 0.160.1 remains the compatibility floor. CI uses 0.165.0; the floor is not a second full CI matrix. This …

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 …

Local implementation and acceptance completed The local 0.1.0-dev implementation passed the checks recorded here. The CLI source is committed as e623d93; public publication, downstream adoption, and production deployment remain separate and have not …

Historical source and binary evidence This record preserves earlier R1–R8/A18 acceptance. Command changes do not rewrite those results. The reduced CLI and its Cobra/text/JSON/YAML interface on 2026-10-04 are defined by the current contract and …

OINK 1.2.0 Paper and Slate ship in 1.2.0. Ink and Terminal are included as explicit opt-ins; their remaining design work is recorded below. Decision Paper is the default, with warm paper/ink colors, blue links, IBM Plex Sans, heading hairlines and …

OINK 1.2.0 contract This contract describes the v1.2.0 release. Its canonical bilingual sources are in content/docs/design/. This is source and configuration guidance, not a release ledger. Local source, commit, tag, push, consumer pin, deployment, …

Current scope; local candidate This contract describes the reduced local 0.1.0-dev command surface on 2026-10-04. Keep site diagnosis, real Hugo checks, initialization, builds, upgrades, and guarded maintenance plans. Cobra provides command help; …

Release preparation, not publication This record separates the reviewed baseline, committed fixes, completed validation, and remaining publication steps. A passing baseline CI run does not certify the later fixes. The sections through Limits …

Phase 1 released in 1.2.0; Ink/Terminal opt-ins available Paper, Slate and the Appearance menu ship with OINK 1.2.0. The architecture contract, accepted decision and acceptance record own phase-one behavior and evidence. A subsequent Ink/Terminal …

OINK 1.2.0 contract This contract describes the v1.2.0 release. Its canonical bilingual sources are in content/docs/design/. Shared rules live in the architecture and component contracts; migration belongs in the migration contract. Shell and data …

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, …

Original review snapshot This research records source inspection, live GitHub status, local builds, and targeted browser observations on 2026-09-19. At the initial review checkpoint, the recommendations were not yet accepted contracts or implemented …

Implemented requirements record The finite R1–R8 supported local implementation and A18 runtime/archive scope passed for the historical source and binaries recorded in the acceptance supplement. The current reduced CLI requires its own validation. …

OINK 1.2.0 contract This contract describes the v1.2.0 release. Its canonical bilingual sources are in content/docs/design/. Authorities and navigation Concern Authority Global navigation Hugo menus.main Docs / Book sidebar and pager content tree or …

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 …

Local first-stage candidate; later roadmap remains draft The independent Go repository pgsty/oink-cli and first-stage development were authorized on 2026-09-29. Its six commands now have a local 0.1.0-dev implementation, with final local acceptance …

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.2.0 contract This contract describes the v1.2.0 release. Its canonical bilingual sources are in content/docs/design/. Tutorials and exhaustive examples belong in the reader-facing Components section. This page defines the API and behavior …

Local evidence only This record concerns sibling-checkout theme output, with no injected prototype styles. It is not a release, a consumer upgrade, or hosted-site acceptance. Inputs Theme and documentation working trees on 2026-10-05; Hugo Extended …

Local candidate evidence This review covers the October 5 working trees, including uncommitted changes. It does not certify an immutable release commit or a published 1.2.0 module. The public theme tag and the documentation site’s consumer pin …

Local experiment, not a release Ink and Terminal now compile into the actual theme stylesheet and use the existing Appearance control. These are not injected screenshot styles. They remain explicitly enabled experiments, pending design acceptance. …

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.2.0 contract This contract describes the v1.2.0 release. Its canonical bilingual sources are in content/docs/design/. Repository and assembly The repository root is a Hugo Module and complete theme, not a site or npm workspace. Hugo Extended …