Skip to content

Test the documentation build helpers - #215

Merged
botre merged 4 commits into
masterfrom
chore/quality-pass-2026-10-25
Oct 25, 2026
Merged

botre merged 4 commits into
masterfrom
chore/quality-pass-2026-10-25

Conversation

@botre

@botre botre commented Oct 25, 2026

Copy link
Copy Markdown
Contributor

The site suites checked the build helpers only through the built output. A wrong rule showed up as a broken link or a missing file. This PR adds unit suites for page addresses, frontmatter, Markdown copy links, the head and breadcrumbs. The page actions now read the site address from urls.js. Two comments lose claims that no longer hold.

The built pages do not change. The urls.js import adds a few string helpers to the client bundle. The PR adds no linter or type checker, since the repo has neither.

  1. Run pnpm build.
  2. Run pnpm exec vitepress preview docs.
  3. Open /setup/spam-protection.html.
  4. Open the arrow menu beside Copy Markdown.
  5. Click Copy for agents.
  6. Check that the prompt names https://documentation.formspark.io/setup/spam-protection.md.

botre added 4 commits October 25, 2026 14:49
Every suite under tests/site now names what it checks as built, and the
two that repeated the README's note on when the site suites run no longer
do.
The site suites check the built output as a whole, so a wrong rule in a
helper showed up only as a missing file or a broken link. Unit suites now
cover how a page maps to its address, how frontmatter is read, how links in
a Markdown copy are rewritten, and how the head and breadcrumbs are built.
Each suite is named after the module it covers.
The page actions read the documentation's address from urls.js instead of
a second copy, and the sidebar test maps links with linkPath, which it
already imported.
The comment named a build hook this site does not have. The module header
no longer lists who imports it.
@botre
botre merged commit f51148b into master Oct 25, 2026
1 check passed
@botre
botre deleted the chore/quality-pass-2026-10-25 branch October 25, 2026 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant