Skip to content

docs: refresh README and testing guidance - #33

Merged
ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-audit-20261008
Oct 8, 2026
Merged

ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-audit-20261008

Conversation

@ryanbarlow97

Copy link
Copy Markdown
Contributor

Move staff commands and ammunition details into Docs; describe current automatic refresh and test coverage.

Follows the README layout and documentation ownership rules in TF-Minecraft/Docs. Related guide updates: TF-Minecraft/Docs#110.

Validation: git diff --check; README links, source paths and anchors checked against the task worktrees. Feature and test claims checked against current source and build configuration. Plugin/runtime suites were not rerun for these documentation edits.

@coderabbitai

coderabbitai Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 2b1c8596-2010-4489-b934-0916e86f958f
📥 Commits

Reviewing files that changed from the base of the PR and between 4d50cb2 and 1aa0c05.

📒 Files selected for processing (1)
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the ammunition guide to explain how to select supported ammunition for the next reload.
    • Added information about maintained weapons and staff provisioning, and removed the staff gun commands section.
    • Revised testing guidance to cover the test tools used, where reports are available, CI uploads, and in-game checks.

Walkthrough

The README updates descriptions of ammunition selection, gun stat updates, and staff provisioning. It removes the staff gun commands section and revises documentation links, test reports, CI uploads, and in-game check guidance.

Changes

README documentation

Layer / File(s) Summary
Feature overview
README.md
The ammunition description now covers selecting supported ammunition for the next reload. The README adds bullets about gun stat updates and staff provisioning. The workbench-to-combat section remains unchanged.
Command and test documentation
README.md
The staff gun commands section is removed, and the Documentation section adds a link about commands and ammunition handling. Test guidance now names JUnit 5, Mockito, and MockBukkit, gives report locations, notes CI uploads, and identifies checks that require in-game testing.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to 1aa0c

The README update is mergeable after normal checks; no material documentation inaccuracy was established.

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ryanbarlow97
ryanbarlow97 merged commit e5b4844 into main Oct 8, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-audit-20261008 branch October 8, 2026 20:27
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