docs: align repo-structure handbook workflow summaries with current automation #66

New issue

Closed

opened 2026-03-22 23:00:39 +00:00 by pokebedrock-bot · 0 comments

pokebedrock-bot commented

2026-03-22 23:00:39 +00:00

(Migrated from github.com)

Summary

The handbook repo-structure pages still describe the current GitHub workflows too narrowly.

Evidence

docs/en/handbook/repo-structure.md says:
- ci.yml # Lint + link-check on PRs
- search-index.yml # Builds and uploads search docs
docs/es/handbook/repo-structure.md carries the same stale summary in Spanish.
Current automation is broader:
- .github/workflows/ci.yml runs npm ci, npm run ci, and npm run audit:prod.
- .github/workflows/search-index.yml builds build/search-index.json, build/search-indices.json, and the generated frontend content manifests under build/content/<locale>/.

Impact

Contributors using the repo-structure handbook get an outdated mental model of what CI actually verifies and what the search workflow produces.

Acceptance Criteria

Update the English and Spanish repo-structure handbook pages so the workflow summaries match the current automation.
Mention that ci.yml runs npm run ci plus npm run audit:prod.
Mention that search-index.yml builds search payloads and frontend content manifests.

## Summary The handbook repo-structure pages still describe the current GitHub workflows too narrowly. ## Evidence - `docs/en/handbook/repo-structure.md` says: - `ci.yml # Lint + link-check on PRs` - `search-index.yml # Builds and uploads search docs` - `docs/es/handbook/repo-structure.md` carries the same stale summary in Spanish. - Current automation is broader: - `.github/workflows/ci.yml` runs `npm ci`, `npm run ci`, and `npm run audit:prod`. - `.github/workflows/search-index.yml` builds `build/search-index.json`, `build/search-indices.json`, and the generated frontend content manifests under `build/content/<locale>/`. ## Impact Contributors using the repo-structure handbook get an outdated mental model of what CI actually verifies and what the search workflow produces. ## Acceptance Criteria - Update the English and Spanish repo-structure handbook pages so the workflow summaries match the current automation. - Mention that `ci.yml` runs `npm run ci` plus `npm run audit:prod`. - Mention that `search-index.yml` builds search payloads and frontend content manifests.