Skip to content

docs: refresh README and testing guidance - #38

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

Shorten feature descriptions, move goldsmithing finishing rules into Docs and complete test-report guidance.

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: a42f735a-8dea-4a6c-b5e9-2fc3a2a17c12
📥 Commits

Reviewing files that changed from the base of the PR and between 67c18a2 and 9791a1d.

📒 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 goldsmithing project description to distinguish craftsmanship from material recovery.
    • Added a link to the goldsmithing and finishing rules.
    • Clarified test framework and report locations, CI report uploads, and which checks require in-game testing.

Walkthrough

The README revises the goldsmithing overview, links to goldsmithing and finishing rules, and updates test report details and in-game testing notes.

Changes

README guidance

Layer / File(s) Summary
Feature and test guidance
README.md
The README describes goldsmithing features and separates craftsmanship and material recovery. It adds a link to goldsmithing and finishing rules. The tests section names JUnit 5, lists Surefire and JaCoCo report locations, notes CI uploads both, and identifies checks that require in-game testing.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to 9791a

No actionable merge-blocking risk is established for these README updates.

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