Skip to content

Update documentation for non-destructive default mode and restoration progress reporting#5

Merged
modpotato merged 2 commits into
mainfrom
copilot/update-repository-documentation
Nov 7, 2025
Merged

Update documentation for non-destructive default mode and restoration progress reporting#5
modpotato merged 2 commits into
mainfrom
copilot/update-repository-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 7, 2025

The README incorrectly stated destructive mode as default and lacked documentation for recently merged restoration progress reporting features.

Corrected default mode documentation

  • Fixed statement that non-destructive mode is the default (enable-destructive-actions: false)
  • Added clear mode switching instructions via command or config

Documented restoration progress reporting

  • Immediate scheduling summary (chunks, locations, world)
  • Periodic updates: time-based (60s intervals) + percentage-based (1% for ≥1000 locations, 10% otherwise)
  • Final completion message with total blocks restored and elapsed time
  • Player opt-out control via /antinetherite restore-feedback <on|off>

Cleanup

  • Removed duplicate lines in Features and Commands sections
Original prompt

Update repository documentation to reflect recently merged features and clean up obsolete files.

Tasks:

  1. README enhancements:
    • Clearly state default mode is non-destructive (enable-destructive-actions: false) and describe switching to destructive.
    • Add section describing blended Ancient Debris restoration progress reporting: immediate scheduling summary + periodic time/percentage updates and final completion message.
    • Document new command: /antinetherite restore-feedback <on|off> and per-user feedback opt-out behavior.
    • Document new config keys (if present): anti-netherite.advanced.restore-progress-threshold, anti-netherite.advanced.restore-progress-interval-seconds, anti-netherite.advanced.restore-feedback-default. Provide defaults and effects.
    • Update restoration section to describe scheduling mechanics for Paper vs Folia, batching, region-safe updates, and that progress counts only consider attempted locations still NETHERRACK.
    • Remove any duplicated bullet points (previous duplicate container transfer item) and ensure consistent naming (replace-when-mined / replace-on-chunk-load; no "replace-ancient-debris" alias unless noted).
    • Reflect bypass permission behavior now uniformly across listeners except automated container transfers (explicitly clarify scope of bypass).
  2. Purge obsolete docs:
    • Remove todo.md or similar obsolete planning files if they exist (search for TODO.md, todo.md, tasks.md). If none found, skip removal.
  3. Minor polish:
    • Ensure command list includes restore-feedback.
    • Ensure examples show both dotted and alias setting forms for /set.
    • Fix any lingering typos or truncated color constants references.
  4. Leave config.yml unchanged; this is documentation-only PR.

Acceptance criteria:

  • README contains updated sections above without internal contradictions.
  • Obsolete doc files removed (if they exist); otherwise no change.
  • Build passes (no code changes expected beyond docs cleanup).
  • PR title concise and descriptive.

This pull request was created as a result of the following prompt from Copilot chat.

Update repository documentation to reflect recently merged features and clean up obsolete files.

Tasks:

  1. README enhancements:
    • Clearly state default mode is non-destructive (enable-destructive-actions: false) and describe switching to destructive.
    • Add section describing blended Ancient Debris restoration progress reporting: immediate scheduling summary + periodic time/percentage updates and final completion message.
    • Document new command: /antinetherite restore-feedback <on|off> and per-user feedback opt-out behavior.
    • Document new config keys (if present): anti-netherite.advanced.restore-progress-threshold, anti-netherite.advanced.restore-progress-interval-seconds, anti-netherite.advanced.restore-feedback-default. Provide defaults and effects.
    • Update restoration section to describe scheduling mechanics for Paper vs Folia, batching, region-safe updates, and that progress counts only consider attempted locations still NETHERRACK.
    • Remove any duplicated bullet points (previous duplicate container transfer item) and ensure consistent naming (replace-when-mined / replace-on-chunk-load; no "replace-ancient-debris" alias unless noted).
    • Reflect bypass permission behavior now uniformly across listeners except automated container transfers (explicitly clarify scope of bypass).
  2. Purge obsolete docs:
    • Remove todo.md or similar obsolete planning files if they exist (search for TODO.md, todo.md, tasks.md). If none found, skip removal.
  3. Minor polish:
    • Ensure command list includes restore-feedback.
    • Ensure examples show both dotted and alias setting forms for /set.
    • Fix any lingering typos or truncated color constants references.
  4. Leave config.yml unchanged; this is documentation-only PR.

Acceptance criteria:

  • README contains updated sections above without internal contradictions.
  • Obsolete doc files removed (if they exist); otherwise no change.
  • Build passes (no code changes expected beyond docs cleanup).
  • PR title concise and descriptive.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI self-assigned this Nov 7, 2025
Co-authored-by: modpotato <81768237+modpotato@users.noreply.github.com>
Copilot AI changed the title [WIP] Update repository documentation for recent features and cleanup Update documentation for non-destructive default mode and restoration progress reporting Nov 7, 2025
Copilot AI requested a review from modpotato November 7, 2025 07:11
@modpotato modpotato marked this pull request as ready for review November 7, 2025 07:46
@modpotato modpotato merged commit 26e92dd into main Nov 7, 2025
2 checks passed
@modpotato modpotato deleted the copilot/update-repository-documentation branch November 7, 2025 08:01
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.

2 participants