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

Move LuckPerms setup details into Docs and clarify current tests and report locations.

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: d3d4013d-1b02-4288-92d1-9ec5143dfd78
📥 Commits

Reviewing files that changed from the base of the PR and between 367aa93 and f2284dc.

📒 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 README overview and feature descriptions to cover account linking, website codes, account updates, tier synchronisation and player metadata sharing.
    • Revised build and testing guidance, including where to find dependency preparation instructions and test reports, and which external systems are not covered by tests.
    • Removed the dedicated LuckPerms bridge section and its configuration and operating details.

Walkthrough

The README now describes TFMCWeb’s account-linking, website-code and account-update functions. It removes the dedicated LuckPerms bridge section and updates build and test guidance.

Changes

README update

Layer / File(s) Summary
Project description and testing guidance
README.md
The README updates the project and feature descriptions, removes the dedicated LuckPerms bridge section, and revises test, coverage and report details.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to f2284

The README’s revised feature descriptions and core testing guidance are supported by the checked-in project; no confirmed issue currently blocks merging.

  • 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 457d6b2 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