Checks
every reason the wiki is not fit to read
wiki check builds the site in a temporary folder and lists every problem at once, not only the
first.[1] It exits with 0 for a sound wiki, 1 when it finds a problem, and 2 when it is misused,
such as pointed where there is no wiki.[1] The same check runs on every push and pull request
through Continuous integration. A check proves that a sentence cites
something, not that the citation is true; an agent checks that from the Review prompt.
Order
Every check runs before the result is decided, so one problem never hides another.[1][2]
flowchart LR
accTitle: What wiki check does
accDescr: wiki check builds the site in a temporary folder. A page that cannot be built stops it with exit code 1; otherwise it runs every check, lists every problem and every claim with no source, and exits 1 if there is a problem or 0 if not.
run(["wiki check run"]) --> build["Build the site in a temporary folder"] --> built{"Every page built?"}
built -- "No" --> stopped(["Stopped with the reason, exit 1"])
built -- "Yes" --> checks["Run every check"] --> list["List problems and unsourced claims"]
list --> any{"Any problem?"}
any -- "Yes" --> failed(["Exit 1"])
any -- "No" --> passed(["Exit 0"])
Refusals
| Refused | Described on |
|---|---|
| A sentence that cites nothing, or a reference to a document[3] | Citations |
| An infobox row that cites nothing[4] | Citations |
| A heading that asks a question, rates its contents or points at the page[5] | Headings |
| A title, label or sentence that points at the project instead of naming it[6] | Pointing words |
| A link to a wiki page that does not exist[7] | Site |
| A page longer than its budget[8] | Reading budgets |
| A picture whose subject has changed[9] | Pictures |
| A page edited since its date was recorded[10] | Site |
| A wiki written against a different release of the tool[11] | Skill |
Stoppages
Some problems stop the build instead of joining the list, such as a missing wiki.toml or goals.md,
a page with no title or intent, a page that no reader can reach, a sidebar naming a page that does not exist
or a picture with no record.[12] When that happens, only that one problem is reported, as a single
sentence, and the command exits with 1.[2]