Skip to content

docs: refresh README and testing guidance - #32

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

Align normal verification and mandatory coverage instructions; move the Paper helper manual into Docs with a source pointer.

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: 9d8b5a39-8563-4fa3-a2d8-acd6d5a6ad30
📥 Commits

Reviewing files that changed from the base of the PR and between 8a4b501 and d96019f.

📒 Files selected for processing (2)
  • README.md
  • integration-tests/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 feature overview to explain that pet recovery preserves pets and learning across restarts, including pets outside their Pet House.
    • Revised test guidance with the verification command, report locations, coverage requirements and CI report uploads. It also notes that Paper behaviour and client rendering need separate checks.
    • Clarified that the Paper integration check is for development and requires a separate server run, with setup and result instructions available in the testing guide.

Walkthrough

The README files now describe pet recovery and update instructions for test verification and the dev-only Paper integration check.

Changes

Project documentation

Layer / File(s) Summary
Pet recovery description
README.md
The Features list describes recovery of pets and learning across restarts, including pets outside their Pet House.
Test and integration-check guidance
README.md, integration-tests/README.md
The README documents mvn clean verify, test and coverage reports, coverage requirements, and separate Paper-behaviour and client-rendering checks. The integration-tests README summarises the dev-server requirement and links to testing and technical documentation.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: nowkoo

Merge Risk: ⚪ Minimal · up to d9601

No actionable risk was found in these documentation changes; the described verification and Paper-check workflows match the project configuration.

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