Skip to content

Commit 85f16bf

Browse files
committed
docs: publish OINK v1.1.0 documentation
1 parent 1777382 commit 85f16bf

47 files changed

Lines changed: 274 additions & 217 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Landing pages, and migration boundaries.
1313
Do not clone this regression repository as a project template. Use the small,
1414
public GitHub template at
1515
[`pgsty/oink-starter`](https://github.com/pgsty/oink-starter), then follow the
16-
[Starter tutorial](https://oink.pgsty.com/docs/start/starter/). It pins the
17-
current release and includes neutral Docs, Blog, Book, language profiles, and
16+
[Starter tutorial](https://oink.pgsty.com/docs/start/starter/). It pins a
17+
published release and includes neutral Docs, Blog, Book, language profiles, and
1818
GitHub Pages / Cloudflare Pages workflows without this site's test harness or
1919
project-specific configuration.
2020

content/blog/release/1.1.0.md

Lines changed: 18 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,20 @@ title: OINK 1.1.0 — Native locales, navigation, and site extensions
33
linkTitle: OINK v1.1.0
44
date: 2026-09-20T00:00:00+08:00
55
lastmod: 2026-09-20T00:00:00+08:00
6-
draft: true
6+
draft: false
77
description: >-
8-
Release preparation for OINK 1.1.0: 32 native interface catalogs, taxonomy
8+
OINK 1.1.0 brings 32 native interface catalogs, taxonomy
99
directories, reliable sidebar state, site-owned search actions, and fixes
1010
for printing, keyboard focus, and copying images.
1111
authors: [oink]
1212
categories: [release]
1313
tags: [Oink, Release]
1414
series: [oink-releases]
1515
series_weight: 31
16+
release_url: https://github.com/pgsty/oink/releases/tag/v1.1.0
1617
---
1718

18-
> [!IMPORTANT] Release preparation — 2026-09-20
19-
> This draft describes the implementation prepared on `main` for OINK 1.1.0.
20-
> Neither `v1.1.0` nor a release-candidate tag has been published. The current
21-
> public release and this site's module pin remain `v1.0.0`. Source acceptance
22-
> is complete; tag publication, the documentation site's dependency upgrade,
23-
> and deployment remain separate steps to complete.
24-
25-
OINK 1.1.0 is prepared as the first minor release after the stable 1.0 contract.
19+
OINK 1.1.0 is the first minor release after the stable 1.0 contract.
2620
It completes the native interface catalogs, makes taxonomy roots useful as
2721
navigation directories, and addresses community feedback about sidebar state,
2822
keyboard focus, grouping, and search extensions. Existing 1.0 content and
@@ -176,9 +170,8 @@ passed the [pinned-toolchain theme CI](https://github.com/pgsty/oink/actions/run
176170
Hugo checks, browser-runtime tests, and Book publication checks. The earlier
177171
community-fix acceptance and the subsequent bilingual image-copy regression
178172
are recorded in the [upstream review](/docs/design/research/2026-09-19-upstream-review/).
179-
Those are source and test results, not evidence of a public 1.1.0 release.
180173
The additional initialization, action-concurrency, and keyboard-focus fixes
181-
and final candidate acceptance are recorded in the
174+
and source acceptance are recorded in the
182175
[release review](/docs/design/research/2026-09-20-release-review/).
183176
Local acceptance passed 44 JavaScript tests, 57 site tests, and 149 Chromium
184177
tests. Hugo Extended 0.160.1 also passed the selected compatibility checks and
@@ -189,20 +182,21 @@ is supplied. Checker-owned Hugo processes have a 120-second ceiling, and
189182
redundant warning-fatal builds were removed while retaining per-case
190183
diagnostic and fallback assertions.
191184

192-
The source candidate has passed acceptance. Publication still needs a
193-
resolvable public tag, a matching consumer pin and checksum, a build using
194-
that published module, and deployed-page checks. This draft will be updated
195-
with the publication evidence when those steps complete.
185+
The published [`v1.1.0`](https://github.com/pgsty/oink/releases/tag/v1.1.0) tag
186+
points to [`3a18234`](https://github.com/pgsty/oink/commit/3a18234aa3af15ae12e2d53839ffd321ef4bcb62),
187+
which adds only the finalized changelog to the accepted implementation and
188+
passed all three [release-commit CI jobs](https://github.com/pgsty/oink/actions/runs/35482327047).
189+
A fresh-cache download from the [official Go module proxy](https://proxy.golang.org/github.com/pgsty/oink/@v/v1.1.0.info)
190+
resolved to that commit; the module archive and `go.mod` checksums were verified
191+
against [sum.golang.org](https://sum.golang.org/lookup/github.com/pgsty/oink@v1.1.0).
196192

197-
## Upgrade {#upgrade}
193+
A theme release does not update consumer sites automatically. Each site still
194+
needs to pin the new module, build it without a filesystem replacement, and
195+
verify the deployed output.
198196

199-
Until the tag is published, keep production on its current known-good pin.
200-
Maintainers can preview the prepared implementation with the sibling-checkout
201-
`make check`, `make browser`, and `make dev` targets described in the
202-
[local preview guide](/docs/admin/preview/); these do not change `go.mod`.
197+
## Upgrade {#upgrade}
203198

204-
**After `v1.1.0` is published and resolves through the module proxy**, upgrade
205-
with:
199+
Pin the published version and run a strict production build:
206200

207201
```bash
208202
hugo mod get github.com/pgsty/oink@v1.1.0
@@ -217,4 +211,4 @@ alongside the site's language, light/dark, and subpath routes. Detailed steps
217211
are in the [1.0-to-1.1 upgrade checklist](/docs/admin/upgrade/#from-1-0).
218212

219213
The repository-level change ledger remains in
220-
[CHANGELOG.md](https://github.com/pgsty/oink/blob/main/CHANGELOG.md).
214+
[CHANGELOG.md](https://github.com/pgsty/oink/blob/v1.1.0/CHANGELOG.md).

content/blog/release/1.1.0.zh.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,19 @@ title: OINK 1.1.0:原生多语言界面、导航与站点扩展
33
linkTitle: OINK v1.1.0
44
date: 2026-09-20T00:00:00+08:00
55
lastmod: 2026-09-20T00:00:00+08:00
6-
draft: true
6+
draft: false
77
description: >-
8-
OINK 1.1.0 发布准备:32 份原生界面目录、分类法目录、可靠的侧栏状态、站点自定义
8+
OINK 1.1.0 带来 32 份原生界面目录、分类法目录、可靠的侧栏状态、站点自定义
99
搜索动作,以及打印、键盘焦点和图片复制修复。
1010
authors: [oink]
1111
categories: [release]
1212
tags: [Oink, Release]
1313
series: [oink-releases]
1414
series_weight: 31
15+
release_url: https://github.com/pgsty/oink/releases/tag/v1.1.0
1516
---
1617

17-
> [!IMPORTANT] 发布准备 — 2026-09-20
18-
> 本草稿说明 `main` 上为 OINK 1.1.0 准备的实现。`v1.1.0` 与候选版本标签均未发布;
19-
> 当前公开版本与本站模块固定版本仍是 `v1.0.0`。源码验收已完成;发布标签、文档站
20-
> 升级依赖与部署仍是尚待完成的独立步骤。
21-
22-
OINK 1.1.0 按稳定 1.0 契约之后的第一个次版本准备:补齐原生界面翻译,让分类法根页
18+
OINK 1.1.0 是稳定 1.0 契约之后的第一个次版本:补齐原生界面翻译,让分类法根页
2319
成为实用的导航目录,并处理社区对侧栏状态、键盘焦点、内容分组与搜索扩展的反馈。
2420
现有 1.0 内容与配置不需要迁移源码。
2521

@@ -134,26 +130,30 @@ partial、受支持的搜索后端与迁移工具均继续保留。
134130
实现提交 [`08f6563`](https://github.com/pgsty/oink/commit/08f656303ba4b1299db92973bc02a4c5d3ba1ca3) 已通过
135131
[固定工具链主题 CI](https://github.com/pgsty/oink/actions/runs/35477171223) 的 Hugo 检查、
136132
浏览器运行时测试与 Book 出版检查。此前的社区修复验收,以及后续中英文图片复制回归,
137-
记录在[上游调研报告](/zh/docs/design/research/2026-09-19-upstream-review/)这些是源码
138-
与测试结果,不能作为 1.1.0 已公开发布的证据。补充的初始化、动作并发与键盘焦点修复
139-
及最终候选验收记录在[发布审查报告](/zh/docs/design/research/2026-09-20-release-review/)
133+
记录在[上游调研报告](/zh/docs/design/research/2026-09-19-upstream-review/)补充的初始化、
134+
动作并发与键盘焦点修复,以及源码验收记录在
135+
[发布审查报告](/zh/docs/design/research/2026-09-20-release-review/)
140136
本地验收通过 44 项 JavaScript 测试、57 项站点测试和 149 项 Chromium 测试。
141137
Hugo Extended 0.160.1 也通过定向兼容性检查与真实文档站的严格生产构建。
142138

143139
输出检查器默认构建新 fixture,只有显式指定输出目录时才复用已有结果。检查器启动的
144140
每个 Hugo 进程都有 120 秒上限;重复的 warning-fatal 构建已去除,逐例诊断与回退断言
145141
仍然保留。
146142

147-
源码候选已通过验收;发布阶段还要提供可解析的公开标签、固定消费站依赖及校验和、
148-
用公开模块构建,再检查部署后的页面。本草稿会在这些步骤完成后补齐发布证据。
143+
已发布的 [`v1.1.0`](https://github.com/pgsty/oink/releases/tag/v1.1.0) 标签指向
144+
[`3a18234`](https://github.com/pgsty/oink/commit/3a18234aa3af15ae12e2d53839ffd321ef4bcb62)
145+
该提交仅在已验收实现上收口更新日志,并通过全部三项
146+
[发布提交 CI](https://github.com/pgsty/oink/actions/runs/35482327047)
147+
通过全新缓存从[官方 Go 模块代理](https://proxy.golang.org/github.com/pgsty/oink/@v/v1.1.0.info)
148+
下载的版本准确解析到该提交;模块归档与 `go.mod` 的校验和均已通过
149+
[sum.golang.org](https://sum.golang.org/lookup/github.com/pgsty/oink@v1.1.0) 验证。
149150

150-
## 升级 {#upgrade}
151+
主题发布不会自动更新消费站。各站点仍需固定新模块,在没有文件系统替换的情况下
152+
构建,并验证部署后的输出。
151153

152-
标签发布前,生产站点继续使用当前已知可用的固定版本。维护者可按
153-
[本地预览指南](/zh/docs/admin/preview/) 使用同级 checkout 的 `make check`
154-
`make browser``make dev` 验证准备中的实现;这些命令不会修改 `go.mod`
154+
## 升级 {#upgrade}
155155

156-
**`v1.1.0` 发布并能通过模块代理解析后**,再执行
156+
固定公开版本并执行严格生产构建
157157

158158
```bash
159159
hugo mod get github.com/pgsty/oink@v1.1.0
@@ -167,4 +167,4 @@ hugo --cleanDestinationDir --gc --minify --environment production \
167167
[1.0 → 1.1 升级核对项](/zh/docs/admin/upgrade/#from-1-0)
168168

169169
仓库级完整变更记录继续保存在
170-
[CHANGELOG.md](https://github.com/pgsty/oink/blob/main/CHANGELOG.md)
170+
[CHANGELOG.md](https://github.com/pgsty/oink/blob/v1.1.0/CHANGELOG.md)

content/docs/_index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ OINK is a Hugo theme for technical documentation. Components are part of the
4343
Markdown syntax rather than a second template language; the fonts, icons,
4444
search and diagram runtimes the browser needs ship with the theme; the only
4545
build dependency is one Hugo Extended binary, with no Node.js and no CDN
46-
request. The current release is {{% param version %}}.
46+
request. The current release is {{% param version %}}; see the
47+
[OINK 1.1 release notes](/blog/release/1.1.0/) and
48+
[upgrade guide](/docs/admin/upgrade/#from-1-0).
4749

4850
## Five ways in {#five-entries}
4951

content/docs/_index.zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ cascade:
2929
search_boost: 1.35
3030
---
3131

32-
OINK 是一款技术文档 Hugo 主题。组件是 Markdown 语法的一部分,不是另一套模板语言;浏览器需要的字体、图标、搜索与图表运行时随主题分发;构建依赖只有一个 Hugo Extended 二进制,不需要 Node.js,不请求 CDN。当前发布版本 {{% param version %}}。
32+
OINK 是一款技术文档 Hugo 主题。组件是 Markdown 语法的一部分,不是另一套模板语言;浏览器需要的字体、图标、搜索与图表运行时随主题分发;构建依赖只有一个 Hugo Extended 二进制,不需要 Node.js,不请求 CDN。当前发布版本 {{% param version %}},详见 [OINK 1.1 发布注记](/zh/blog/release/1.1.0/)[升级指南](/zh/docs/admin/upgrade/#from-1-0)
3333

3434
## 五条入口 {#five-entries}
3535

content/docs/admin/upgrade.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Upgrade
33
linkTitle: Upgrade
4-
description: Pin a published theme version, prepare a 1.0-to-1.1 upgrade, migrate legacy content or a Docsy site, and roll back safely.
4+
description: Pin a published theme version, upgrade from 1.0 to 1.1, migrate legacy content or a Docsy site, and roll back safely.
55
weight: 50
66
search_keywords: [upgrade, migration, version, Hugo Module, hugo mod get, oink06, Docsy, jQuery, breaking changes]
77
aliases:
@@ -34,13 +34,12 @@ guessing afterwards why a page looks different.
3434
## Upgrading the Hugo Module {#hugo-module}
3535

3636
A production site pins a published release tag or a deliberately selected
37-
immutable commit, follows no branch, and does not use `@latest`. As of
38-
2026-09-20, the public release is `v1.0.0`; `v1.1.0` is still in preparation.
39-
The example below uses the available tag. Use a later tag only after its
40-
publication and module resolution have been verified:
37+
immutable commit, follows no branch, and does not use `@latest`. The example
38+
below upgrades to the published `v1.1.0` tag. For a later release, verify its
39+
publication and module resolution before selecting that tag:
4140

4241
```bash {title="Terminal"}
43-
hugo mod get github.com/pgsty/oink@v1.0.0 # the verified published tag
42+
hugo mod get github.com/pgsty/oink@v1.1.0 # the published release tag
4443
hugo mod tidy
4544
hugo mod graph | grep github.com/pgsty/oink
4645
```
@@ -56,7 +55,7 @@ module github.com/pgsty/oink.pgsty.com
5655

5756
go 1.27.0
5857

59-
require github.com/pgsty/oink v1.0.0
58+
require github.com/pgsty/oink v1.1.0
6059
```
6160

6261
> [!DANGER] A local module replacement overrides that pin
@@ -70,7 +69,7 @@ check out the exact published version rather than following its remote branch:
7069

7170
```bash {title="Terminal"}
7271
git -C themes/oink fetch origin --tags
73-
git -C themes/oink checkout --detach v1.0.0
72+
git -C themes/oink checkout --detach v1.1.0
7473
git add themes/oink
7574
```
7675

@@ -99,12 +98,12 @@ Once the build passes, look with your own eyes: the home page, a documentation
9998
page, a blog page, the 404, both languages, both colour schemes, the print view,
10099
and anywhere the site customized something.
101100

102-
## Preparing the 1.0-to-1.1 upgrade {#from-1-0}
101+
## Upgrading from 1.0 to 1.1 {#from-1-0}
103102

104-
> [!IMPORTANT] Implementation prepared; release pending
105-
> This checklist describes the implementation on `main` as of 2026-09-20.
106-
> `v1.1.0` is not yet a published module tag. It does not change the production
107-
> version pinned above or prove that a consumer has been deployed.
103+
> [!IMPORTANT] OINK 1.1.0 upgrade checklist
104+
> This checklist covers the published v1.1.0 release. Each consumer still needs
105+
> to update its dependency pin, rebuild and deploy; theme publication does not
106+
> upgrade an existing site automatically.
108107
109108
No source migration is required from 1.0.0. Hugo Extended 0.160.1 remains the
110109
floor; CI uses the pinned 0.165.0 toolchain. The module's Go 1.27.0 directive is
@@ -134,7 +133,7 @@ Update or remove affected site-level copies of theme code after comparing
134133
them with the new implementation. A copied old image-zoom script or sidebar
135134
partial will otherwise continue to hide the upstream fix.
136135

137-
To test a local candidate with the documentation site, use its sibling theme
136+
To test local theme changes with the documentation site, use its sibling theme
138137
checkout without committing a filesystem replacement:
139138

140139
```bash {title="Terminal — from oink.pgsty.com"}
@@ -143,8 +142,8 @@ make browser
143142
make dev
144143
```
145144

146-
These commands validate the local checkout. After publication, pin the exact
147-
release, build without a module replacement, then validate the deployed pages.
145+
These commands validate the local checkout. For release acceptance, pin the
146+
published version, build without a module replacement, then validate the deployed pages.
148147
The authoring and API details live in [content groups](/docs/write/organize/#group-only),
149148
the [sidebar contract](/docs/design/shell/#sidebar-runtime),
150149
[search actions](/docs/customize/panel/#search-tail), and

content/docs/admin/upgrade.zh.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 版本升级
33
linkTitle: 版本升级
4-
description: 固定已发布的主题版本、准备从 1.0 升到 1.1、迁移旧内容或 Docsy 站点,并在出问题时安全回滚。
4+
description: 固定已发布的主题版本、 1.0 升到 1.1、迁移旧内容或 Docsy 站点,并在出问题时安全回滚。
55
weight: 50
66
search_keywords: [升级, 迁移, 版本, Hugo Module, hugo mod get, oink06, Docsy, jQuery, 破坏性变更, upgrade, migration]
77
aliases:
@@ -29,11 +29,11 @@ aliases:
2929
## 升级 Hugo Module {#hugo-module}
3030

3131
生产站点固定已发布标签或主动选定的不可变 commit,不跟随分支,也不用 `@latest`
32-
截至 2026-09-20,公开版本是 `v1.0.0``v1.1.0` 仍在准备中。下面使用已可用的标签;
33-
更新版本需先确认已经发布且模块可以解析,再替换示例中的版本。
32+
下面升级到已发布的 `v1.1.0` 标签;选择后续版本时,先确认已经发布且模块可以解析,
33+
再替换示例中的版本。
3434

3535
```bash {title="终端"}
36-
hugo mod get github.com/pgsty/oink@v1.0.0 # 已确认发布的标签
36+
hugo mod get github.com/pgsty/oink@v1.1.0 # 已发布的版本标签
3737
hugo mod tidy
3838
hugo mod graph | grep github.com/pgsty/oink
3939
```
@@ -47,7 +47,7 @@ module github.com/pgsty/oink.pgsty.com
4747

4848
go 1.27.0
4949

50-
require github.com/pgsty/oink v1.0.0
50+
require github.com/pgsty/oink v1.1.0
5151
```
5252

5353
> [!DANGER] 本地模块替换会盖掉这个固定版本
@@ -58,7 +58,7 @@ require github.com/pgsty/oink v1.0.0
5858

5959
```bash {title="终端"}
6060
git -C themes/oink fetch origin --tags
61-
git -C themes/oink checkout --detach v1.0.0
61+
git -C themes/oink checkout --detach v1.1.0
6262
git add themes/oink
6363
```
6464

@@ -80,11 +80,11 @@ hugo --gc --minify --printPathWarnings --panicOnWarning --logLevel info
8080

8181
构建通过之后,人眼再过一遍:首页、一个文档页、一个博客页、404、两种语言、两种配色、打印视图,以及站点自己定制过的地方。
8282

83-
## 准备从 1.0 升到 1.1 {#from-1-0}
83+
## 1.0 升到 1.1 {#from-1-0}
8484

85-
> [!IMPORTANT] 实现已准备,版本尚未发布
86-
> 本清单说明截至 2026-09-20 的 `main` 实现。`v1.1.0` 还不是已发布的模块标签,
87-
> 这份清单不改变上面的生产版本固定,也不代表任何消费站已经部署
85+
> [!IMPORTANT] OINK 1.1.0 升级清单
86+
> 本清单对应已发布的 v1.1.0。各消费站仍需更新依赖固定版本、重新构建和部署;
87+
> 主题发布不会自动升级既有站点
8888
8989
从 1.0.0 升级不需要迁移源码。Hugo Extended 0.160.1 仍是下限,CI 固定使用 0.165.0,
9090
模块的 Go 1.27.0 声明与 1.0.0 相同。在 Hugo 0.160.x 上,非默认通用 `zh` 与区域中文
@@ -111,15 +111,15 @@ hugo --gc --minify --printPathWarnings --panicOnWarning --logLevel info
111111
将受影响的站点级主题副本与新实现比较后再更新或移除。保留旧图片缩放脚本或侧栏
112112
partial,会让站点继续使用旧实现,无法获得上游修复。
113113

114-
在文档站验证本地候选实现时,使用同级主题 checkout,不要提交文件系统模块替换:
114+
在文档站验证本地主题修改时,使用同级主题 checkout,不要提交文件系统模块替换:
115115

116116
```bash {title="终端 — 在 oink.pgsty.com 目录内"}
117117
make check
118118
make browser
119119
make dev
120120
```
121121

122-
这些命令验证的是本地 checkout。发布后,再固定精确版本,在没有模块替换的情况下
122+
这些命令验证的是本地 checkout。验收正式版本时,固定已发布标签,在没有模块替换的情况下
123123
构建,并验证部署后的页面。创作与 API 细节见[内容分组](/zh/docs/write/organize/#group-only)
124124
[侧栏契约](/zh/docs/design/shell/#sidebar-runtime)
125125
[搜索动作](/zh/docs/customize/panel/#search-tail)[图片缩放](/zh/docs/components/image/#zoom)

content/docs/components/image/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ and gallery images that have alt text become clickable buttons that open the
182182
full image in a native `<dialog>` (Esc closes it, focus returns where it was).
183183
This page turns it on in its front matter, so every image above is clickable.
184184

185-
The 1.1 implementation on main keeps the preview action in the button's
185+
Since OINK 1.1, the preview action is kept in the button's
186186
accessible name, alongside the image description. It adds no helper text to
187187
copied articles; the copied HTML retains images and authored captions for
188188
rich-text editors. In v1.0.0, a hidden preview label can appear after pasting.

0 commit comments

Comments
 (0)