registrystack / registrystack/registry-stack

Add deterministic search for the currently released documentation archive

Aperta
#516 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area:docs enhancement triage:roadmap
Lingua principale
Rust
Stelle
2
Fork
0
Merge medio
2h 55m
PR unite (30g)
130

Descrizione

## User impact and evidence

Production documentation must not mix unreleased v0.14 search data with the immutable v0.13 release archive. The recovery therefore serves direct released routes and excludes the unreleased Pagefind index from the production artifact. The v0.13 archive was sealed without a deterministic search index.

## Why this is non-blocking now

The restored homepage, Start routes, and exact task links provide direct navigation for the governed first-country journeys. Copying the v0.14 index into v0.13 would create a mixed-release public surface. Search becomes blocking only if independent human acceptance shows direct navigation is insufficient or a future release gate explicitly requires released-site search.

## Owner

Registry Stack documentation and release maintainers.

## Prerequisites

- A deterministic index format and build procedure whose bytes can be included in the release docset digest.
- A release-boundary decision covering canonical URLs, archived content, and stale-index rejection.
- Retained fresh-reader navigation evidence from the corrected direct routes.

## Reconsideration trigger

Promote this work when a fresh-reader exercise records inability to find the governed task through direct navigation, or before a release whose acceptance criteria require search over the released archive.

## Expected verification

- Search results contain only the selected immutable released docset.
- Repeated builds from the same frozen source produce identical index bytes.
- The index digest is covered by the release archive and lock.
- Unreleased, draft, and other-version content cannot appear in results.
- Missing or mismatched indexes fail closed without breaking direct navigation.
- Production staging never copies a preview index into a released archive.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia risolvendo il formato dell’indice deterministico e la procedura di build, quindi la decisione al confine della release per gli URL canonici, i contenuti archiviati e il rifiuto degli indici obsoleti. Verifica che build ripetuti a partire da sorgenti congelate coincidano, che il digest sia coperto dall’archivio della release e dal lock, che i contenuti esclusi non possano comparire, che gli errori si chiudano in modo sicuro e che staging non copi mai un indice di preview in un archivio rilasciato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation, release, search
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.