Skip to content

docs: refresh README and testing guidance - #50

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 weapon commands into Docs and clarify shared dependencies and test limitations.

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: ca452ab9-9a4a-4444-b18d-d8f886535492
📥 Commits

Reviewing files that changed from the base of the PR and between d314cb9 and d78c773.

📒 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
    • Removed the staff weapon command’s usage, requirements, permissions and tab-completion guidance from the README.
    • Updated test instructions to reference the pinned shared and private dependencies, identify MockBukkit and Mockito as integration mocks, and point to the Surefire report location.
    • Clarified that live Paper behaviour, provider integrations and client visuals require separate gameplay checks.

Walkthrough

The README removes the staff weapon command documentation and updates the test instructions with dependency references, mock tools, the Surefire report location, and gameplay checks that require separate validation.

Changes

README updates

Layer / File(s) Summary
Command and test documentation
README.md
Removes the staff weapon command details. Updates test guidance to reference pinned dependencies, MockBukkit and Mockito, the Surefire report location, and separate gameplay checks for live Paper behaviour, provider integrations, and client visuals.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to d78c7

The README now points readers to the Docs-owned staff guide and updates test references without introducing a material workflow risk.

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