Skip to content

docs: move the resource-pack manual to Docs - #35

Merged
ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-norms
Oct 3, 2026
Merged

ryanbarlow97 merged 1 commit into
mainfrom
docs/readme-norms

Conversation

@ryanbarlow97

Copy link
Copy Markdown
Contributor

Summary

  • Delete root RESOURCE_PACK.md; it now lives at Docs projects/TFMCCore/resource-pack.md (updated for native /tfmc pack).
  • Remove the extra paragraph from the License section so it holds only the standard text.
  • Add a short Tests section describing the CI test run.

Paired Docs PR: TF-Minecraft/Docs#93 (merge it first or together).

Checks

  • Docs link and index checks pass on the paired PR.
  • No code changes.

🤖 Generated with Claude Code

The multipart resource-pack guide now lives in TF-Minecraft/Docs at
projects/TFMCCore/resource-pack.md. The License section keeps only the
standard text, and a Tests section describes the CI test run.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 3, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

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: afeb1b9c-1e87-4dc9-9fd9-313a11fe62e7
📥 Commits

Reviewing files that changed from the base of the PR and between 9e577c1 and c04762b.

📒 Files selected for processing (2)
  • README.md
  • RESOURCE_PACK.md
💤 Files with no reviewable changes (1)
  • RESOURCE_PACK.md

Limit details: You’ve used all 10 included reviews currently available.


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the README with test requirements and instructions, including the required Java version and verification command. It also describes the test coverage areas, CI reporting, and testing limitations.
    • Removed the resource-pack delivery guide.

Walkthrough

The README adds test-running instructions and describes test coverage and CI reporting. The README no longer references RESOURCE_PACK.md, which has been deleted.

Changes

Project documentation updates

Layer / File(s) Summary
README test guidance and resource-pack documentation removal
README.md, RESOURCE_PACK.md
The README adds Java 21 test instructions, describes the stated test coverage and CI reports, and notes that no coverage gate or live Paper server startup is used. It removes its reference to RESOURCE_PACK.md, which documented resource-pack generation, delivery, setup, and rollback. The file is deleted.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: justinasla

Merge Risk: ⚪ Minimal · up to c0476

This documentation-only change adds test guidance and moves the resource-pack manual to the Docs repository. No merge-blocking risk is established.

Architecture Summary

Architecture risk: 🔵 Low · up to c0476

The change affects 2 systems.

Changed systems: README.md, RESOURCE_PACK.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — README.md (service) was modified; 1 changed file maps to changed impact.
  • observed — RESOURCE_PACK.md (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in README.md: Adds test-running instructions and documentation describing the stated test coverage, CI triggers and reports, coverage-gate status, and lack of live Paper server startup.
  • observed — Modified behavior in README.md: Removes the License-section reference to RESOURCE_PACK.md and its description of opt-in resource-pack generation, delivery, deployment, and rollback.
  • observed — Modified behavior in RESOURCE_PACK.md: The entire RESOURCE_PACK.md document was removed, including its description of multipart pack generation and delivery, request and failure handling, automatic ItemsAdder bridging, Dev setup, rollback steps, and compatibility and validation information.
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Usage-based review receipt

  • Mode: Continue automatically
  • Reviewed files: 1
  • Waived: $0.25 (charged $0.00)
  • View usage details

Note

This review exceeded your plan’s limits and used usage-based reviews—free during trial, billed after paid activation unless disabled. Manage usage-based reviews.


Comment @coderabbitai help to get the list of available commands.

@ryanbarlow97
ryanbarlow97 merged commit 7f3bff4 into main Oct 3, 2026
2 checks passed
@ryanbarlow97
ryanbarlow97 deleted the docs/readme-norms branch October 3, 2026 22:55
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