Docs: clarify tracked build artifacts in repository inventory #130

New issue

Closed

opened 2026-04-18 15:05:32 +00:00 by pokebedrock-bot · 0 comments

pokebedrock-bot commented

2026-04-18 15:05:32 +00:00

(Migrated from github.com)

Summary

DOCUMENTATION.md still describes generated build/ output as a local/runtime artifact in places, even though this repo intentionally tracks build/search-index.json, build/search-indices.json, and the frontend content manifests under build/content/<locale>/.

Impact

The inventory document gives contributors conflicting guidance about whether build/ is source-controlled.
That makes the generated-artifact policy harder to understand when npm run check:generated fails.

Acceptance criteria

DOCUMENTATION.md clearly distinguishes transient compiled tooling under build/scripts/ from the tracked fallback/search manifest JSON under build/.
The scope/notes sections no longer imply all build/ output is untracked local runtime state.
Local validation still passes (npm run ci).

## Summary `DOCUMENTATION.md` still describes generated `build/` output as a local/runtime artifact in places, even though this repo intentionally tracks `build/search-index.json`, `build/search-indices.json`, and the frontend content manifests under `build/content/<locale>/`. ## Impact - The inventory document gives contributors conflicting guidance about whether `build/` is source-controlled. - That makes the generated-artifact policy harder to understand when `npm run check:generated` fails. ## Acceptance criteria - `DOCUMENTATION.md` clearly distinguishes transient compiled tooling under `build/scripts/` from the tracked fallback/search manifest JSON under `build/`. - The scope/notes sections no longer imply all `build/` output is untracked local runtime state. - Local validation still passes (`npm run ci`).