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 0.6.0 contract This section publishes the maintainer contracts released with OINK 0.6.0, with Hugo Extended 0.160.1 as the compatibility floor. The canonical bilingual sources live in this repository under content/docs/design/. This section is …

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 0.6.0 contract This is the migration contract released with OINK 0.6.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 0.6.0 contract This is the landing-page contract released with OINK 0.6.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 …

OINK 0.6.0 contract This is the shell and navigation contract released with OINK 0.6.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 …

Draft PRD — partial premise already exists OINK already supports per-page Markdown, language-local llms.txt, HTML discovery links, and Copy Markdown. It does not currently publish llms-full.txt or a navigation JSON. Only those remaining outputs are …

Draft PRD — remaining work only OINK already has a shared content-image resolver, one Zoom marker, processed Markdown images, numbered figures, and safe Landing URL handling. This page proposes only the unresolved convergence; it must not be read as …

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 0.6.0 contract This is the component contract released with OINK 0.6.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 …

Draft PRD — not implemented OINK currently has no backlink block, local graph, global graph page, or graph output format. Names and configuration in this proposal are not public API until the proposal is accepted and the contracts change. Premise …

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 0.6.0 contract This is the architecture contract released with OINK 0.6.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 …