From 9aac947a83a19ab75a4ecf897d23b626229bc1c1 Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Fri, 6 Nov 2026 13:09:58 +0800 Subject: [PATCH 1/2] Record the review of the published wiki (RC-013) --- docs/artifact-registry.md | 2 +- docs/sqa/reviews/rc-013-wiki-published.md | 59 +++++++++++++++++++++++ 2 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 docs/sqa/reviews/rc-013-wiki-published.md diff --git a/docs/artifact-registry.md b/docs/artifact-registry.md index 3eb49d7..c3182d1 100644 --- a/docs/artifact-registry.md +++ b/docs/artifact-registry.md @@ -15,7 +15,7 @@ document of a type. `Primary File` may contain a glob (e.g. | SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 | | PP | Project Plan | docs/project-plan.md | 002 | | MIL | Milestone / Gateway | docs/milestones/*.md | 005 | -| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 013 | +| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 014 | ## Languages diff --git a/docs/sqa/reviews/rc-013-wiki-published.md b/docs/sqa/reviews/rc-013-wiki-published.md new file mode 100644 index 0000000..8c6742a --- /dev/null +++ b/docs/sqa/reviews/rc-013-wiki-published.md @@ -0,0 +1,59 @@ +# RC-013 Wiki review after publishing + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-013 | +| CrossReference | [MIL-004], [QC-WIKI-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | pending | + +--- + +## Artifact Under Review + +- Instance reviewed: [MIL-004] +- Checklist used: [QC-WIKI-001] +- Scope: delta re-review of criterion 14 after the merge of the pull request (earlier record RC-011); the other rows are carried over unchanged +- Language and domain: en, da, ms (wiki, not a PO-language artifact type) +- Language reviewer: none; the Danish and Bahasa Malaysia translations are by the AI and are not independently checked +- Mode: autonomous, not independent (the reviewer is `AI as stand-in for S01`) + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | The wiki has a `_Sidebar.md`, because the host lists subpages only through it | Pass | docs/wiki/_Sidebar.md exists | +| 2 | The sidebar starts with the wiki's title in bold, then one list of the pages in the primary language (English), `Home` first | Pass | Sidebar starts with the bold title Higher or Lower, then one English page list with Home first | +| 3 | The page list holds a link to every English page of the wiki, and no link points to a page that does not exist | Pass | All seven English pages are listed; a script checked that every link in the pages resolves to a file | +| 4 | A `**Related**` section follows the page list only when the wiki has related wikis (for example the checklists wiki for a framework wiki); each entry is a link to that wiki's Home. A wiki with nothing related has no such section | N-A | The wiki has no related wikis, so no Related section | +| 5 | A `**Languages**` section is the last section of the sidebar. It has one line per language, the language written in that language, linking to that language's `Home` page | Pass | Languages section is last: English, Dansk, Bahasa Melayu, each linking to its Home | +| 6 | The sidebar does not repeat the page list per language | Pass | The page list appears once | +| 7 | A sidebar produced by a generator carries a comment that says so and names the generator; the generator is changed, not the page | N-A | The sidebar is hand-written, not generated | +| 8 | The wiki has a `Languages` line on each page (criterion 11), so the sidebar is not the only way to switch language | Pass | Every page starts with the language line | +| 9 | Every wiki exists in English and, as a minimum, in the language the project's registry names as the PO language; further languages are added on top, never instead of English | Pass | English, Danish and Bahasa Malaysia exist; the PO language is English | +| 10 | Every English page has a page in each other language of the wiki: the page sets are identical | Pass | Eight pages (Home, six lecture pages, Run-and-Test) exist in each language | +| 11 | Every page starts with the language line, with the current language in bold and a link to the same page in each other language | Pass | Each page starts with the language line, current language in bold | +| 12 | A page in a language other than English is named `-.md`, with a BCP 47 code; English has no suffix | Pass | Danish and Bahasa Malaysia pages are named Page-da.md and Page-ms.md; English has no suffix | +| 13 | Code blocks, commands, file names and IDs stay in English in every language | Pass | Code, commands, file names and IDs are English in every language | +| 14 | The sidebar, every page and every link were checked on the published wiki after the change, not only in the repository | Pass | After the merge the publish workflow created 25 wiki pages on the host; the sidebar and the Home, lecture and Run-and-Test pages in all three languages answer HTTP 200, the language and sidebar links point to existing pages, and the 8 screenshots are served from the raw URLs the pages use | +| 15 | A change to the layout rules (sections, order, naming) is made in the generator or template and in this checklist's source rules together | N-A | No change to layout rules | +| 16 | The wiki folder (`docs/wiki/`) is flat: every page, `Home.md` and `_Sidebar.md` included, is directly in it, and languages are told apart by file name, never by a subfolder | Pass | All pages and the sidebar are directly in docs/wiki, no subfolder | + +## Overall Verdict + +Go — Criterion 14 is closed by checking the published wiki; every other criterion passes or is not applicable. The Danish and Bahasa Malaysia text remains machine-written and is flagged for S01 in the action items; it does not block. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| Native-speaker check of the Danish and Bahasa Malaysia text | S01 | 2026-11-16 | + +--- + +[MIL-004]: ../../docs/milestones/mil-004-docs-screenshots-wiki.md +[QC-WIKI-001]: ../../framework/qc/artifacts/qc-wiki.md -- 2.54.0 From c9e39f0445aeffd747b0964396145b1bd229664e Mon Sep 17 00:00:00 2001 From: Jens Tirsvad Nielsen Date: Fri, 6 Nov 2026 13:09:59 +0800 Subject: [PATCH 2/2] Resolve the RC-013 commit link --- docs/sqa/reviews/rc-013-wiki-published.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sqa/reviews/rc-013-wiki-published.md b/docs/sqa/reviews/rc-013-wiki-published.md index 8c6742a..7834a50 100644 --- a/docs/sqa/reviews/rc-013-wiki-published.md +++ b/docs/sqa/reviews/rc-013-wiki-published.md @@ -9,7 +9,7 @@ ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | pending | +| 2026-11-06 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version | [9aac947] | --- @@ -57,3 +57,4 @@ Go — Criterion 14 is closed by checking the published wiki; every other criter [MIL-004]: ../../docs/milestones/mil-004-docs-screenshots-wiki.md [QC-WIKI-001]: ../../framework/qc/artifacts/qc-wiki.md +[9aac947]: https://git.tirsystem.com/Tirsvad-Udemy-100-days-of-code/055-higher-lower/commit/9aac947a83a19ab75a4ecf897d23b626229bc1c1 -- 2.54.0