Skip to content

docs: refresh README and testing guidance - #26

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

Qualify failure penalties and configurable physician access; document test tools, reports and runtime 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: e9cb6785-1c8d-4861-97b2-f7872442e066
📥 Commits

Reviewing files that changed from the base of the PR and between 2c59799 and a493110.

📒 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
    • Clarified that failed procedures extend recovery only after sedation or cutting, and updated the description of default Physician permissions.
    • Summarised instruments by their uses.
    • Expanded testing guidance with framework and coverage details, the location of test results, and clarification that live RPCharacters integration and multiplayer play require server testing.

Walkthrough

The README now clarifies procedure recovery, Physician permissions, and instrument uses. It also updates the testing instructions with build guidance, test coverage details, and server-testing requirements.

Changes

README documentation

Layer / File(s) Summary
Feature and testing guidance
README.md
The feature descriptions clarify recovery conditions, default Physician permissions, and instrument uses. Testing instructions link to the build guide, list test frameworks and coverage areas, identify the Surefire results location, and specify which checks require server testing.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: justinasla

Merge Risk: ⚪ Minimal · up to a4931

The documentation changes are supported by the inspected project sources and configuration. No material merge risk remains.

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