Skip to content

docs: move the activity descriptions guide to Docs - #88

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 ACTIVITY-LORE.md; it now lives at Docs projects/ActivityTF/ACTIVITY-LORE.md, and the README links there.
  • Add a Tests section: mvn clean verify as CI runs it, plus the description tool's Python tests (not run in CI).

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

Checks

  • python3 -m unittest discover -s tools -p 'test_*.py' passes.
  • No code changes.

🤖 Generated with Claude Code

ACTIVITY-LORE.md now lives in TF-Minecraft/Docs at
projects/ActivityTF/ACTIVITY-LORE.md; the README links there instead. Add a
Tests section describing the CI test run and the description tool's tests.

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: 8dc7b0ae-d473-4512-8d0a-015a03b45ebb
📥 Commits

Reviewing files that changed from the base of the PR and between 78d1dc8 and c3310d9.

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

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


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the README to link to the activity descriptions and placeholders in the TF-Minecraft documentation.
    • Added information on running the Java and Python tests, including test coverage and CI reporting.
    • Removed the local activity lore and configuration migration documentation.

Walkthrough

The README now links to activity documentation and includes test instructions. The local activity lore document was removed.

Changes

Documentation updates

Layer / File(s) Summary
Activity references and test guidance
README.md, ACTIVITY-LORE.md
The README links to activity descriptions and placeholders in the TF-Minecraft documentation. It adds Java and Python test instructions. The local activity lore document was removed.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: xxfran10xx

Merge Risk: ⚪ Minimal · up to c3310

The activity guide link is available, and the documented test commands match the supplied workflow and test-module context. No identified issue currently blocks merging.

Architecture Summary

Architecture risk: 🔵 Low · up to c3310

The change affects 2 systems.

Changed systems: ACTIVITY-LORE.md, README.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

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

Before / after behavior

  • observed — Modified behavior in ACTIVITY-LORE.md: The file’s documentation of description placeholders, activity counting and award rules, config-update tooling, and the 2026-09-30 activity audit was removed.
  • observed — Modified behavior in README.md: The local activity lore and config migration link was removed. The section now links to activity descriptions and placeholders in the documentation repository, alongside the existing project and technical documentation links.
  • observed — Modified behavior in README.md: A Tests section was added with the Maven verification command, a summary of JUnit 5 test coverage and CI behaviour, and the Python unittest command for tool tests, which CI does not run.
  • 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 e0bfb4a 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