Help us shape the future of Go! Take the 2026 Go Developer Survey

docscheck

command
v0.62.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2026 License: BSD-3-Clause Imports: 9 Imported by: 0

Documentation

Overview

Command docscheck asks which GENERATOR a published documentation URL was built with, and whether a site's default entry point serves the same one as its development tip.

docscheck https://go-pkgx.github.io/docs https://go-images.github.io/docs

WHY IT EXISTS

⛔ BECAUSE I WITHDREW A CORRECT BUG REPORT ON BAD EVIDENCE. The question was whether `/docs/latest/` was the old MkDocs site or the new Hextra one, and I answered it from a FILE LISTING — assets/, 404.html, search/, sitemap.xml.gz — concluded Hextra, and closed the report. mkdocs-material produces every one of those. Shared artefacts cannot separate two candidates; only a marker that exactly one of them emits can.

mkdocs-material namespaces its classes `md-` (md-header, md-nav); Hextra carries its own name (hextra, hx-). Measured on the same page that fooled the listing: 66 mkdocs-material markers and 0 Hextra ones under `latest/`, against 0 and 22 under `main/`.

⛔ AND NO STATUS CODE SAYS IT. Both URLs answer 200. A site whose entry point is built by a different generator from its tip is not "a version behind", it is the SUPERSEDED SITE still being served — on go-pkgx that entry point tells a reader to type `pkgx ls`, which since pkgx#113 runs GNU ls, so the published documentation now contradicts the shipped tool rather than merely lagging it.

WHAT IT MEASURED

2026-10-20, four sites: go-pkgx, go-images and go-filesystems each serve mkdocs-material at `latest/` and Hextra at `main/`; go-plot serves Hextra at `latest/` and has no `main/`, and it is the one that was migrated by hand as the reference for the others.

⛔ THAT FOURTH SITE IS WHY THE COMPARISON IS NARROW. An HTTP 404, a timeout and a redirect stub are each a real answer and NONE of them is a generator: comparing them as if they were reports go-plot — the one site that is right — as a mismatch. Two pages are compared only when both named a generator, and what could not be read is counted and reported apart, because a scan that read nothing must never print the same verdict as a scan that read everything and found it clean.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL