Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

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

未关闭
  • 哪里不对？
#29 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
65/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
shell, typescript
领域
devops, documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.
主要语言
TypeScript
星标
189
派生
40
平均合并
7 小时 38 分钟
30 天内合并 PR
30

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

nextlevelbuilder/skillx 的其他 Issue

查看 nextlevelbuilder/skillx 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。