summaryrefslogtreecommitdiffstats
path: root/WORKFLOW.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-04-29 12:32:30 +0200
committerDanilo M. <danix@danix.xyz>2026-04-29 12:32:30 +0200
commit9c50525b7ecf4f93e057ecbe162ea818b105319e (patch)
tree6b82f5af7f02bd7a34573fd42bd7afe582fda794 /WORKFLOW.md
parent27d3ca03f3393291ad47115725252332726531d7 (diff)
downloaddanixxyz-9c50525b7ecf4f93e057ecbe162ea818b105319e.tar.gz
danixxyz-9c50525b7ecf4f93e057ecbe162ea818b105319e.zip
docs: add obsolete article banner usage to workflow guiderelease_29042026-1232
Diffstat (limited to 'WORKFLOW.md')
-rw-r--r--WORKFLOW.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/WORKFLOW.md b/WORKFLOW.md
index f8e6fee..c95141f 100644
--- a/WORKFLOW.md
+++ b/WORKFLOW.md
@@ -66,6 +66,23 @@ git commit -m "config: ..."
git push origin master
```
+### Mark an article as obsolete
+
+Add `obsolete = true` to the article's front matter. Optionally link to a successor article with `successor = "/path/to/article"`:
+
+```toml
++++
+title = "My Old Article"
+# ... other fields ...
+obsolete = true
+successor = "/articles/my-new-article"
++++
+```
+
+The banner appears automatically below the article header. If `successor` is set, it resolves the article title and links to it. Both EN and IT i18n strings are customizable in `i18n/en.yaml` and `i18n/it.yaml`.
+
+Paths are Hugo permalinks — for English articles, use `/articles/slug`, not `/en/articles/slug`.
+
---
## Working on the Theme