docs: align README automation summary with current workflows #64

New issue

Closed

opened 2026-03-22 19:14:18 +00:00 by pokebedrock-bot · 0 comments

pokebedrock-bot commented

2026-03-22 19:14:18 +00:00

(Migrated from github.com)

Summary

README.md still describes the repo automation too loosely compared with the current workflows on main.

Evidence

README.md says npm run check is the "Full suite (lint + link check)", but package.json shows npm run ci is the real PR/CI gate (lint + lint:links + check:generated).
README.md says ci.yml runs "lint + validation + link checks for every PR", but .github/workflows/ci.yml also runs npm run audit:prod.
README.md says search-index.yml builds search-index.json and search-indices.json, but the workflow artifact on main also uploads the generated frontend content manifests under build/content/<locale>/.

Impact

Contributors reading the repo entrypoint can miss the actual CI gate and search artifact set, which makes local verification and release/debugging guidance drift from reality.

Acceptance criteria

README script descriptions clearly distinguish npm run check from npm run ci.
README CI summary mentions that wiki-ci also runs npm run audit:prod.
README search workflow summary states that the uploaded artifact includes both the search JSON payloads and the generated frontend content manifests.

## Summary `README.md` still describes the repo automation too loosely compared with the current workflows on `main`. ## Evidence - `README.md` says `npm run check` is the "Full suite (`lint` + link check)", but `package.json` shows `npm run ci` is the real PR/CI gate (`lint` + `lint:links` + `check:generated`). - `README.md` says `ci.yml` runs "lint + validation + link checks for every PR", but `.github/workflows/ci.yml` also runs `npm run audit:prod`. - `README.md` says `search-index.yml` builds `search-index.json` and `search-indices.json`, but the workflow artifact on `main` also uploads the generated frontend content manifests under `build/content/<locale>/`. ## Impact Contributors reading the repo entrypoint can miss the actual CI gate and search artifact set, which makes local verification and release/debugging guidance drift from reality. ## Acceptance criteria - README script descriptions clearly distinguish `npm run check` from `npm run ci`. - README CI summary mentions that `wiki-ci` also runs `npm run audit:prod`. - README search workflow summary states that the uploaded artifact includes both the search JSON payloads and the generated frontend content manifests.