Skip to content

docs: refresh README and testing guidance - #144

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 detailed installation-trade mechanics into Docs and keep the README focused on current features and tests.

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: 224f22e6-f3a0-4a91-a5fb-4ea9587af027
📥 Commits

Reviewing files that changed from the base of the PR and between 0c9991d and f98400d.

📒 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 Features section to describe military infrastructure and its role in guild trade and production.
    • Removed the installation trade section and the /faction construct command syntax.
    • Clarified that branch coverage is reported separately, while retaining the 100% production line coverage requirement.

Walkthrough

The README revises the Military infrastructure description, removes the Installation trade section, and updates its tests and coverage wording.

Changes

README updates

Layer / File(s) Summary
Feature descriptions
README.md
The Military infrastructure description now says transport networks extend guild trade and production. The Installation trade section and its rules and configuration details are removed.
Tests and coverage wording
README.md
The heading changes to “Tests and coverage”. The coverage description says branch coverage is reported separately and retains the 100% production line coverage requirement and CI report uploads.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: drefvelin

Merge Risk: ⚪ Minimal · up to f9840

The README refresh moves installation details to project documentation and updates test and coverage wording. No concrete user or workflow regression is identified, so the change appears mergeable after normal checks.

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