Skip to content

docs(readme): correct install reload step, config path and backup folder - #36

Merged
wisdommen merged 1 commit into
masterfrom
docs/p20-readme-fix
Oct 14, 2026
Merged

wisdommen merged 1 commit into
masterfrom
docs/p20-readme-fix

Conversation

@wisdommen

Copy link
Copy Markdown
Member

What was false / what it is now

  • Install step 3 offered /ultitools reload as a way to load the module JAR. It now says restart the server; /ul reload only reloads configuration.
    • Evidence: monorepo CLAUDE.md Cross-Project Pitfalls; same wording as the UltiEssentials/UltiSocial READMEs.
  • Config path plugins/UltiTools/UltiBackup/config/backup.yml -> plugins/UltiTools/pluginConfig/UltiBackup/config/backup.yml.
    • Evidence: BackupConfig.java:21 @ConfigEntity("config/backup.yml"); UltiToolsPlugin.java:296; the README's own language-folder line already used pluginConfig.
  • FAQ backup folder plugins/UltiTools/UltiBackup/backups/ -> plugins/UltiTools/backups/.
    • Evidence: BackupService.java:67 new File(bukkitPlugin.getDataFolder(), "backups") (the core UltiTools data folder); a real server has plugins/UltiTools/backups/.

Defect classes swept across all fifteen module READMEs: A install-by-reload, B config path, C data/runtime path, D unreleased heading vs. released tag, E future-plan item already shipped. This PR fixes: A, B, C.

Docs-only; gate 3 (real-machine UAT) not applicable. README.md only; line endings unchanged (LF).
Targets master deliberately (modules branch from and merge into master). Not a release.

中文补充 / Chinese supplement

  • 安装步骤 3 把 /ultitools reload 当作加载模块 JAR 的方式。现改为重启服务器;/ul reload 只重载配置。
  • 配置路径 plugins/UltiTools/UltiBackup/config/backup.yml 改为 plugins/UltiTools/pluginConfig/UltiBackup/config/backup.yml。
  • FAQ 中的备份目录 plugins/UltiTools/UltiBackup/backups/ 改为 plugins/UltiTools/backups/。

仅文档修改,第 3 道门(真机 UAT)不适用;只改 README.md,行尾保持 LF。

🤖 Generated with Claude Code

Corrected claims (defect classes: A, B, C):

- Install step 3 offered `/ultitools reload` as a way to load the module JAR. It now says restart the server; `/ul reload` only reloads configuration.
  Evidence: monorepo `CLAUDE.md` Cross-Project Pitfalls; same wording as the UltiEssentials/UltiSocial READMEs.
- Config path `plugins/UltiTools/UltiBackup/config/backup.yml` -> `plugins/UltiTools/pluginConfig/UltiBackup/config/backup.yml`.
  Evidence: `BackupConfig.java:21 @ConfigEntity("config/backup.yml")`; `UltiToolsPlugin.java:296`; the README's own language-folder line already used `pluginConfig`.
- FAQ backup folder `plugins/UltiTools/UltiBackup/backups/` -> `plugins/UltiTools/backups/`.
  Evidence: `BackupService.java:67 new File(bukkitPlugin.getDataFolder(), "backups")` (the core UltiTools data folder); a real server has `plugins/UltiTools/backups/`.

Docs-only; README.md only. Maintainer README rule kept: no server-core version or platform statement is added.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@wisdommen

Copy link
Copy Markdown
Member Author

Gate 2 (local Codex review), run 1 of at most 2. Model: gpt-6.1-sol, reasoning effort: high. Reviewed head: b534026 (codex review --base master, run from a worktree at that head, read-only sandbox). Findings: none. Codex checked the diff against the module source and the local UltiTools-API source, and git diff --check passed. No fix commit, so no second run. Disposition: nothing to answer. Docs-only change; gate 3 not applicable.

@wisdommen

Copy link
Copy Markdown
Member Author

Gate 1 (own code review) - APPROVE.

An independent read-only reviewer checked this head (b534026) against module source on origin/master, the framework on origin/alpha and the v1.0.0 tag. Every changed line is true; the diff is README.md only, LF line endings kept, no whole-file rewrite, no server-platform or version statement added. No P1 or P2 is introduced.

Gate 2: Codex run 1 reported no finding. Gate 3: not applicable (docs-only). Gate 4: CI green. Merging now under the standing merge authority.

@wisdommen
wisdommen merged commit 923936e into master Oct 14, 2026
2 checks passed
@wisdommen
wisdommen deleted the docs/p20-readme-fix branch October 14, 2026 23:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant