Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

docs: recompute runner script and review reports are untracked, rollout steps unreferenced

Aperta
  • Qualcosa non va?
#29 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
65/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
shell, typescript
Ambito
devops, documentation

Direzione di ricerca

Start with the usage header in apps/web/app/routes/api.admin.recompute.ts and inspect scripts/run-recompute.sh, then review docs/deployment-guide.md, docs/UPDATE_SUMMARY.md, and the two plans/reports files. Use git status --porcelain and the documented grep check to verify the files are handled and the script is referenced. Done means the script and reports are committed or deliberately deleted, the update summary is resolved, and the runbook matches the endpoint’s live behavior.

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

Descrizione

documentation

Summary

The bulk-recompute runbook tooling and two code-review reports exist only in the working tree. No commit contains them, and nothing under docs/ references the runner script, so the bulk recompute rollout cannot be reproduced from a clean checkout.

Location

  • Doc: docs/deployment-guide.md (runbook section, currently silent on bulk recompute) and docs/UPDATE_SUMMARY.md
  • Source of truth: apps/web/app/routes/api.admin.recompute.ts:1-12 (the endpoint's own usage header) and scripts/run-recompute.sh

Problem

git status --porcelain reports these paths as untracked:

?? docs/UPDATE_SUMMARY.md
?? plans/reports/code-review-260305-skill-references-scripts.md
?? plans/reports/code-reviewer-260306-1531-admin-recompute-endpoint.md
?? scripts/run-recompute.sh
  • scripts/run-recompute.sh is the operational driver for the recompute endpoint: it defaults API_URL to https://skillx.sh/api/admin/recompute, requires ADMIN_SECRET, takes a batch size argument, and supports resume by re-running.
  • grep -rn 'run-recompute' --include=*.md --include=*.json . excluding node_modules returns no matches, so the script is unreferenced and a maintainer has no documented way to find it.
  • docs/UPDATE_SUMMARY.md describes the Mar 5 documentation pass and overlaps docs/project-roadmap.md, which already records the same Phase 3.1-3.3 completions.

Proposed content

  • Commit scripts/run-recompute.sh and add a short runbook subsection (deployment guide) covering the required ADMIN_SECRET, the batch argument, resume behavior, and the all=true batch cap.
  • Decide the fate of docs/UPDATE_SUMMARY.md: keep it as a dated record or delete it as duplicated by docs/project-roadmap.md.
  • Commit the two review reports under plans/reports/, since the recompute hardening issues cite them as their evidence source.

Acceptance criteria

  • scripts/run-recompute.sh is tracked in git and referenced from a docs page
  • docs/UPDATE_SUMMARY.md is either committed or deleted
  • The two plans/reports/ review reports are committed or deleted
  • Documentation matches live behavior (verified against apps/web/app/routes/api.admin.recompute.ts)

Notes

  • Two further untracked entries, .claude/session-state/ and apps/web/.claude/session-state/, are session state and should stay ignored — they are out of scope here.
  • The review reports are the evidence base for the recompute hardening issues, so deleting them would remove the cited source unless it is summarised into the issues first.
  • Related: PR #9 merged the recompute endpoint itself; this issue only closes the gap between the merged code and its operational instructions.
Lingua principale
TypeScript
Stelle
186
Fork
40
Merge medio
10h 12m
PR unite (30g)
16

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nextlevelbuilder/skillx

Tutte le issue di nextlevelbuilder/skillx

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.