Files
gitea/skills/wiki/SKILL.md
T
jiantw83 89463cd263 docs(wiki): 同步目錄頁條列格式的敘述與工具用法
README 的工具用法、技能行為清單、連結規則與 wiki 技能本文,全部改寫成
目錄頁的區塊格式:參數名從整列改成整個區塊、key-col 的用途縮回只給轉檔
用、補上取標題與換引言的判準,並登錄新增的驗證腳本。

文件與工具講的不是同一件事,呼叫端就會照舊敘述傳整列的表格文字進去,寫出
半表格半條列的頁面。key-col 的語意變動最容易誤解——它從「要換掉哪一欄」
變成「轉檔時哪一欄持有身分」,敘述不改就會被填成別的欄位。

目錄頁條列、內容頁維持圖表優先,這個區分在每一份文件裡都寫明,避免把改版
範圍誤讀成整個 wiki。結束碼說明一併對回工具現況。

功能範圍:目錄頁版面改版的文件同步。
2026-09-02 17:22:29 +08:00

18 KiB
Raw Blame History

name, description
name description
wiki Read or write a Gitea wiki page through tools/gitea.sh, tools/hash-id and tools/page-name.sh. Resolve the wiki repo per page type with JSC_WIKI_REPO_{TYPE} first, then JSC_WIKI_REPO, and ask only when neither is set - every *_CONTENTS page resolves through type CONTENTS and is upserted by tools/wiki-contents.sh as one H2 block per record, and {HASH} is the full 40-char uppercase SHA-1 from tools/hash-id. A contents page carries no markdown table - one H2 block per record, headed by that record's content-page name with one bullet per field - while a content page is chart-first, preferring mermaid diagrams and markdown tables over plain prose, and every link is written as [text](absolute URL) that tools/link-check.sh passed before the write. Callers are jsc-ask, jsc-sdlc, jsc-log, jsc-hooks (ERROR), jsc-cli (CHECK), jsc-meta (SKILLSET, TOOLING) and jsc-assist (MONITOR). Use for any wiki page in the skill set; not for repo code files.

wiki — read and write Gitea wiki pages

Every wiki operation in the jsc skill set goes through this skill. One entry point, one permission path.

Resolve the wiki location

Different page types can live in different {owner}/{repo} repos, classified by the page-name prefix.

  1. Host gate. Confirm GITEA_HOST holds a value in the current shell. When it is missing, ask for it per the jsc-ask:ask rules before any tools/gitea.sh call that reaches the API; otherwise the first thing the user sees is the script's GITEA_HOST is required line instead of a decision-tree question. GITEA_TOKEN needs no inventory here — the script resolves it, retries once with the tea CLI login token, and exits 7 when neither works. Done when GITEA_HOST holds a value.
  2. Run tools/gitea.sh wiki-repo {TYPE}. Allowed types are QUESTION, PLAN, ANALYZE, DELIVER, MAINTAIN, REPO, LOG, LEARN, ERROR, CHECK, REPORT, SKILLSET, TOOLING, MONITOR, and CONTENTS. Every *_CONTENTS page resolves through CONTENTS — all contents pages live in one dedicated repo, so never pass a contents page its own prefix. A content page (*_{HASH}) resolves through its own type. The script reads JSC_WIKI_REPO_{TYPE} first and JSC_WIKI_REPO second, straight from the inherited environment, so take no separate inventory of those two variables. Never borrow another type's repo. Done when the command has printed exactly one {owner}/{repo}, or exited 3 and sent this page type to step 3, or exited 2 on a type outside the list above and stopped the run.
  3. On exit 3 (neither variable is set), ask the user for that page type's {owner}/{repo} per the jsc-ask:ask rules, and suggest setting JSC_WIKI_REPO_{TYPE} (can differ per type, and JSC_WIKI_REPO_CONTENTS holds every contents page) or JSC_WIKI_REPO (shared default). Done when the user has supplied one {owner}/{repo} for that page type.

Operations

Action Command
list pages tools/gitea.sh wiki-list {owner}/{repo}
read page tools/gitea.sh wiki-get {owner}/{repo} {page}
write page write the content to a temp file first, then tools/gitea.sh wiki-put {owner}/{repo} {page} {file} (asks for confirmation first, then creates or updates)
delete page tools/gitea.sh wiki-delete {owner}/{repo} {page} — asks for the same confirmation as a write. Only a migration or an explicit user request may call it
page URL tools/gitea.sh wiki-url {owner}/{repo} {page} — the page's absolute URL, taken from the API's html_url
update a contents page tools/wiki-contents.sh upsert {TYPE} {key-col} {key} {entry-file} [template-file] — resolves the CONTENTS repo, replaces the ## {key} block, appends when the page holds no such heading, writes the whole page back. {entry-file} is that record's whole H2 block. {key-col} only matters while the old page is still a markdown table: it is the 1-based position of the column that carries the record's identity, and the script converts such a page to H2 blocks before the upsert, taking each heading from that cell's link URL — its last path segment, percent-decoded — or from the cell's plain text when the cell holds no link. On that conversion, a supplied {template-file} also replaces the page's H1 and > intro with the template's own, because a conversion moves the table alone and the old intro keeps describing rows; an already-converted page keeps its intro untouched, and so does a conversion run without a template
check a page name tools/page-name.sh check {page} — the single source of the page-name pattern; tools/page-name.sh regex prints it
move pages to the current rules tools/migrate-wiki.sh [--apply] [--key {key}]... — prints the mapping table and the orphan list; writes only with --apply
check links before a write tools/link-check.sh {url}... — prints {OK|DEAD|SKIP}<TAB>{url}<TAB>{reason} per URL; exit 0 means every link is reachable

Every link in a page is written as [text](absolute URL), and the URL comes from wiki-url — one form for every target, inside this wiki or not. Every link goes through tools/link-check.sh before the page is written. Full rules, and why [[...]] was dropped: references/wiki-links.md.

Exit codes

Route every tools/gitea.sh call in this skill on its exit code. A code with no branch below stops the run and gets reported as it is.

Code Meaning What this skill does
0 success use the output
2 usage error, or a page type outside the allowed list fix the arguments, then call again; never repeat the same call unchanged
3 wiki-repo: neither JSC_WIKI_REPO_{TYPE} nor JSC_WIKI_REPO is set go to step 3 and ask
4 HTTP 404: wiki-get and wiki-url found no such page, or wiki-delete found nothing to delete for a read the caller expects to succeed, stop and report the page name; this is the only code that opens the create path of rule 4 — write the page from the template instead of appending. For wiki-delete it means the page is already gone: report it and move on, do not retry
5 wiki-url: the page exists but the API returned no html_url stop and report it. There is no second link form to fall back on, and a hand-built path is not a substitute — never fabricate the URL
7 HTTP 401 or 403 after the tea-token retry: the key is invalid or lacks permission stop the whole operation and report the key problem. Never read this as an empty or missing page, and never take the create path of rule 4: writing a fresh page over one you could not read destroys the record that is still there
8 any other API failure, HTTP status in the message stop and report that status; call again only after the cause is fixed

Helper scripts

Every code below gets its own branch. Nothing here is retried unchanged.

Script Code Meaning What this skill does
tools/hash-id 0 the full 40-char uppercase hash use it as {HASH}
1 this machine has neither sha1sum nor shasum stop, report that one of them has to be installed, compute no hash by hand
2 no text given, or the text was empty fix the key you passed, then call again; never fall back to a hand-made page name
tools/page-name.sh 0 the page name follows the pattern continue with that page name
1 the page name breaks the pattern stop and report the name; build the correct one instead of writing to a wrong page
2 usage error fix the arguments, then call again
tools/wiki-contents.sh 0 the block was updated or added report which of the two, and the page
1 the page content could not be built, or the write failed stop and report; fix the page or the entry before calling again. A missing ## {key} is not this code — that path appends
2 usage error, or an unknown page type fix the arguments, then call again
3 the CONTENTS repo is not configured go to step 3 and ask for JSC_WIKI_REPO_CONTENTS
4 the page is not there and no template was given supply the template for that page type, then call again
7 the key is invalid or lacks permission stop the whole operation and report the key problem; create no page
8 any other API failure stop and report the status
tools/link-check.sh 0 every link is reachable write the page; this is the only code that opens wiki-put
1 at least one link is dead do not write. Report the DEAD rows verbatim, fix or drop those links, then check again
2 usage error: no URL was given fix the arguments, then call again; never skip the check because the list looked empty
3 the list holds a Gitea URL but GITEA_HOST is not set set GITEA_HOST and call again. Never write the page unchecked
7 HTTP 401 or 403: the key is invalid or lacks permission stop the whole operation and report the key problem. Those pages are not dead — treating them as dead deletes or rewrites links to pages that are still there
tools/migrate-wiki.sh 0 every page moved, or the preview found nothing to move report the mapping table
1 at least one page failed to move report the failure list; the old pages of the failed entries stay in place
2 usage error, including an unconfigured CONTENTS repo fix the arguments or set JSC_WIKI_REPO_CONTENTS, then call again
3 something needs manual handling: an orphan page, a page that links to a moved page without being moved itself, or a destination page that already holds content report those lists and hand them to the user; guess no key, and rewrite no link the script left alone

Close the run

Record how the run ended. This is the last thing this skill does, and it runs on every path out of the skill, the ones that stop at the host gate included. Call

jsc-hooks/tools/report-status.sh skill-end jsc-gitea:wiki {status} {exit code} [detail]

{exit code} is the exit code of whatever decided the outcome — the gitea.sh, link-check.sh or wiki-contents.sh call that ruled the run — and 0 when nothing failed. {detail} is one short line, no more than 200 characters; put the page name there, never the page content. If the script is not on this machine, skip this step in silence and finish the run as it stood — missing infrastructure is not a failure, and a reporting call may never change what this skill returns to its caller.

This skill is called by almost every other one, so its status is what the caller reads back. Report the status of this wiki operation only, never the caller's own outcome.

status When this skill uses it
ok The read returned the page, or the write landed: link-check.sh exited 0, the confirmation was given, and wiki-put exited 0
blocked The location could not be resolved, so nothing was read and nothing was written: GITEA_HOST holds no value and the user gave none, or wiki-repo exited 3 and the user supplied no {owner}/{repo} for that page type
failed The operation ran and broke. Exit 7 belongs here: the key is invalid or lacks permission, so the whole operation stopped, and that is a failure, never an absent page. Exit 8, a wiki-put that did not land, a link-check.sh exit 1 that refused the write, and a hash-id or page-name.sh rejection all sit here too
degraded The content page landed and the contents page did not — wiki-put on {TYPE}_{HASH} exited 0, then wiki-contents.sh upsert exited 3 with no CONTENTS repo configured, or exited 1 because the page content could not be built or the write did not land. The record exists but nothing indexes it, so the next reader will not find it. A migration that moved some pages and left orphans or occupied destinations behind sits here as well
aborted The premise did not hold or the user stopped it: write-confirm.sh was refused before a write or a delete, or the caller asked for a page type outside the allowed list and the run stopped at wiki-repo exit 2

Completion condition: exactly one skill-end line was recorded for this run, or the script was absent and the run finished without it.

Rules

  1. Page names must follow the wiki naming table in the skill guidelines (see jsc-meta/references/guidelines.md). Check any page name you build with tools/page-name.sh check {page} before it reaches an API call.
  2. Use tools/hash-id for {HASH} values. It returns the full 40 uppercase SHA-1 hex chars — no truncation, no prefix. Never compute a hash by hand: a hand-made page name lands the content on a page nobody else reads.
  3. A contents page (*_CONTENTS) is one H2 block per record, never a table. The H2 heading is that record's key, written as the content page's own name ({TYPE}_{HASH}) — no link, no URL, no prefix, no date. Every field is one bullet under it, - {field}:{value}, full-width colon, one bullet per field including the key's own. Update it with tools/wiki-contents.sh upsert {TYPE} {key-col} {key} {entry-file} [template-file], where {entry-file} holds that whole H2 block. The script reads the page, converts a page still holding a markdown table into H2 blocks first, replaces the block whose heading equals {key}, appends the block when no heading matches, and writes the whole page back through the same confirmation. {key-col} is used only by that conversion: it is the 1-based position of the old table's identity column, and it is ignored once the page is already in block form. That conversion takes the heading from the identity cell's markdown link — the URL's last path segment, percent-decoded, because the link text is often a work-package or plan name rather than the page name — and from the cell's plain text, backticks stripped, only when the cell holds no link; it never checks the result against the page-name pattern, since old timestamped names, new 40-char names, and plain {owner}/{repo} identities all appear online. That conversion is also the one moment the intro may be rewritten: when {template-file} is given, everything before the first ## — the H1, the > intro, the blank lines between them — is replaced by the template's own preamble, taken the same way and carrying none of the template's demo blocks. Why: the conversion moves the table and leaves the prose, so an intro still saying "one row per repository" outlives the rows it describes, and the template holds the canonical wording. A page already in block form keeps its intro exactly as its owner wrote it — that call only updates its own record — and a conversion run without a template keeps the old intro, there being no canonical copy to install. Never overwrite entries owned by others. Whether the page may be created from the template instead is decided by rule 4, and by nothing else.
  4. Only exit 4 means the page is not there yet — this rule binds every "create it if it does not exist" path, without exception. It is not limited to contents pages: a content page (*_{HASH}), a work log, an error page, a report, any page at all, follows the same branch.
    • Correct branch. Read the page with wiki-get. Exit 0 means the page exists, so append or modify the content that came back and wiki-put the whole page. Exit 4 (HTTP 404) is the one and only code that permits creating a new page from the template.
    • Exit 7 and exit 8 abort. Exit 7 (HTTP 401 or 403) and exit 8 (any other API failure) both mean the old content is unknown, never that the page is missing. Stop the operation and report the exit code with its cause. Create no page, write nothing, and do not retry the same call unchanged.
    • Why. Wiki writes in this skill set are append-not-overwrite, and that semantics rests entirely on reading the old page back first. Reading a 401 as a 404 makes the caller believe it holds a brand-new page and wiki-put a fresh template over a live one, and the whole earlier record is gone — the write carries no merge and no backup.
    • tools/wiki-contents.sh implements exactly this branch for contents pages and reports the same codes.
  5. Write all wiki content in UTF-8 Traditional Chinese, per the STE100 output rule.
  6. Chart-first applies to content pages (*_{HASH}) only. On a content page, prefer visual forms: use mermaid diagrams (flowchart, sequence, gantt, pie) and markdown tables wherever the information allows. Prose is capped at 3 sentences per section, and a sentence stays only when neither a mermaid diagram nor a markdown table can carry the same information. A contents page (*_CONTENTS) always takes the H2-heading-plus-bullets form of rule 3 instead — no table, and no diagram, whatever the field count. Why: the heading is the key the upsert matches on, so the layout is fixed by the tool, not by which form reads better.
  7. tools/gitea.sh retries once with the tea CLI login token when GITEA_TOKEN is missing or the response is 401/403. Report a failure only after that retry also fails.
  8. Rule A — every link is written as [text](absolute URL). That is the only form. [[page]] and [[display|page]] are gone, and there is no longer a same-repo case that keeps them. The URL always comes from tools/gitea.sh wiki-url {owner}/{repo} {page}, never from a path built by hand. Why: [[...]] resolves only inside the current wiki, so a cross-repo link silently lands on a same-named page in this one — and it fails as plain text or a dead link, with nothing to catch it. Contents pages and content pages already live in different repos, so keeping two forms would mean judging, link by link, which repo each end resolves to.
  9. Rule B — check every link before the write. Run tools/link-check.sh {url}... over every link that is going into the page. Exit 0 is the only code that opens wiki-put. Exit 1 means at least one link is dead: write nothing, and hand the caller the DEAD rows. Exit 7 means the key failed, not that the pages are gone — stop and report the key problem. Checking after the write is not the same thing: the dead link is already published, and the next reader follows it.
  10. wiki-delete removes a page for good. Call it only from tools/migrate-wiki.sh --apply, or when the user has asked for that exact page to go. In a migration the delete comes last: write the new page, read it back, then delete the old one.