Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
  • Có gì không ổn?
#29 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
65/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
shell, typescript
Lĩnh vực
devops, documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
TypeScript
Star
186
Fork
40
Merge trung bình
10 giờ 12 phút
Pull request đã merge (30 ngày)
16

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của nextlevelbuilder/skillx

Tất cả issue của nextlevelbuilder/skillx

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.