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

Correct material recovery claims, move artifact settings into Docs and complete dependency and 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: 7e6287bf-ba1a-4fe3-bc0a-7aa74063ad44
📥 Commits

Reviewing files that changed from the base of the PR and between 94152a5 and f9e7db9.

📒 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 feature overview to describe supported inputs and salvage outcomes more generally, with links to system design details for crafting records and artifact yields.
    • Build instructions now point to the dependency guide rather than listing dependency-preparation steps.
    • Coverage-report guidance now specifies JaCoCo report paths and notes that reports are published through CI.

Walkthrough

The README revises feature descriptions, links to system design and build dependency guides, and clarifies JaCoCo coverage-report paths and CI publication.

Changes

README documentation

Layer / File(s) Summary
Feature and build documentation
README.md
Feature descriptions no longer state specific artifact yields, minimum-muffle settings, catalyst-roll behaviour or crafting-record limitations. The README expands the system design link, refers to the build dependency guide and clarifies JaCoCo report paths and CI publication.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to f9e7d

The reviewed README changes accurately describe recovery behavior and CI report publication and are ready to merge.

  • 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 0c15ddd 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