Skip to content

Repository cleanup: docs separation, structure accuracy, content hygiene#50

Merged
Ven0m0 merged 4 commits intomainfrom
copilot/cleanup-repository-structure
Apr 3, 2026
Merged

Repository cleanup: docs separation, structure accuracy, content hygiene#50
Ven0m0 merged 4 commits intomainfrom
copilot/cleanup-repository-structure

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

Six-pass cleanup: separate docs from code, fix stale structure references, remove sprawl, and enforce content standards across all markdown.

Docs separation

  • Created docs/ and moved EXAMPLES.md there
  • Deleted CHANGELOG.md (one-time migration log, not a maintained changelog) and Links.md (low-value link dump)

Structure accuracy (README.md)

Corrected project structure to match disk reality — removed phantom entries that were consolidated during the v2 migration:

  • AHK/ahk/ (case-corrected, was already consolidated)
  • Lib/v1/ removed (never existed; only Lib/v2/ present)
  • Other/Playnite_fullscreen_v2/Playnite_TV.ahkOther/playnite-all.ahk
  • Quick Start GUI paths fixed (GUI_PC.ahk, GUI_Laptop.ahkGUI.ahk)
  • Non-existent downloader scripts removed from Key Scripts table

Content hygiene (13 markdown files)

Applied across all user-facing docs, excluding AI instruction files (AGENTS.md, CLAUDE.md, GEMINI.md):

  • Removed all emojis
  • Removed all uses of "comprehensive" and other promotional language
  • Collapsed multi-blank-line runs, stripped trailing spaces, removed leading/trailing blank lines
  • Updated CLAUDE.md references → AGENTS.md (canonical per repo guidance)

Copilot AI and others added 3 commits April 3, 2026 15:25
@Ven0m0 Ven0m0 marked this pull request as ready for review April 3, 2026 15:39
Copilot AI review requested due to automatic review settings April 3, 2026 15:39
@kilo-code-bot
Copy link
Copy Markdown

kilo-code-bot bot commented Apr 3, 2026

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (6 files)
  • Lib/README.md
  • Other/Citra_per_game_config/README.md
  • Other/Downloader/README.md
  • README.md
  • ahk/Minecraft/README.md
  • ahk/README.md

Incremental Changes (Fixed Issues)

All 6 issues from the previous review have been resolved:

  1. Lib/README.md:271 - Fixed warning label (** CRITICAL:**CRITICAL:)
  2. Other/Citra_per_game_config/README.md:75 - Fixed warning label (** Important:**Important:)
  3. Other/Downloader/README.md:250 - Fixed leading space ( **Input**Input)
  4. README.md:145-146 - Added CLAUDE.md and GEMINI.md to structure tree
  5. ahk/Minecraft/README.md:420-429 - Fixed Server Compatibility section formatting (removed leading spaces)
  6. ahk/README.md:14 - Fixed Keys.ahk description (# hotkey# Hotkey)

Summary

Documentation-only cleanup addressing all formatting issues identified in the previous review. No code or security implications.


Reviewed by minimax-m2.5-20260211 · 79,030 tokens

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR performs a repo-wide documentation cleanup to better separate docs from code, correct README structure references to match the repository, and apply consistent “content hygiene” rules across Markdown files (removing emojis/promotional phrasing and normalizing whitespace).

Changes:

  • Introduced docs/ and moved EXAMPLES.md there; removed CHANGELOG.md and Links.md.
  • Updated README.md to reflect the on-disk structure and current script entry points (paths, tables, and migration section).
  • Normalized Markdown formatting across multiple docs (emoji removal, whitespace cleanup, and updated references to AGENTS.md).

Reviewed changes

Copilot reviewed 11 out of 14 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
README.md Updates overview wording, project structure tree, and key script paths; points examples to docs/EXAMPLES.md.
Other/Robocopy/README.md Trims trailing whitespace / minor formatting cleanup.
Other/Downloader/README.md Formatting cleanup, removes emoji markers, improves spacing.
Other/Citra_per_game_config/README.md Formatting cleanup (noted a broken emphasis marker).
Other/7zEmuPrepper/README.md Removes emoji markers in headings.
Links.md Deleted link-dump document.
Lib/README.md Updates references to AGENTS.md and adjusts formatting (noted a broken emphasis marker).
docs/EXAMPLES.md Whitespace cleanup after move into docs/.
CONTRIBUTING.md Updates structure description and references to AGENTS.md; removes emoji.
CHANGELOG.md Deleted one-time migration log.
ahk/README.md Replaces CLAUDE.md references with AGENTS.md; formatting cleanup (noted spacing/capitalization regression).
ahk/Minecraft/README.md Removes emoji markers; whitespace cleanup (noted unintended indentation).
ahk/GUI/README.md Whitespace cleanup in code blocks.
ahk/Black_ops_6/README.md Removes emoji markers; whitespace cleanup in code blocks.

├── CLAUDE.md # AI assistant development guide
├── GEMINI.md # Additional AI documentation
└── license.md # MIT License
├── AGENTS.md # AI assistant development guide
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Project Structure tree omits CLAUDE.md and GEMINI.md, but both files still exist at repo root (and appear to resolve to the same content as AGENTS.md). Since this section is meant to match disk reality, either include these entries (ideally noting they are symlinks/aliases) or remove the files if they’re no longer intended to exist.

Suggested change
├── AGENTS.md # AI assistant development guide
├── AGENTS.md # AI assistant development guide
├── CLAUDE.md # Alias/symlink to AGENTS.md
├── GEMINI.md # Alias/symlink to AGENTS.md

Copilot uses AI. Check for mistakes.
```

**⚠️ Important:** `tf.ahk` must be in the same folder as the other scripts!
** Important:** `tf.ahk` must be in the same folder as the other scripts!
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The warning label has a space after the opening ** ("** Important:**"), so it won’t render as intended (bold text) and looks like a formatting typo. Remove the extra space so the emphasis marker is **Important:** (or convert to a blockquote admonition if you want it to stand out).

Suggested change
** Important:** `tf.ahk` must be in the same folder as the other scripts!
**Important:** `tf.ahk` must be in the same folder as the other scripts!

Copilot uses AI. Check for mistakes.
Lib/README.md Outdated
## Testing Library Changes

**⚠️ CRITICAL:** Changes to library files affect ALL dependent scripts!
** CRITICAL:** Changes to library files affect ALL dependent scripts!
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The warning label has a space after the opening ** ("** CRITICAL:**"), so it won’t render as intended and reads like a formatting typo. Remove the extra space so it’s **CRITICAL:** (or consider a blockquote style if you want a consistent admonition format).

Suggested change
** CRITICAL:** Changes to library files affect ALL dependent scripts!
**CRITICAL:** Changes to library files affect ALL dependent scripts!

Copilot uses AI. Check for mistakes.
## Security Note

⚠️ **Input Validation:** The scripts have been updated with input validation to prevent command injection vulnerabilities. Do not modify the validation code unless you understand the security implications.
**Input Validation:** The scripts have been updated with input validation to prevent command injection vulnerabilities. Do not modify the validation code unless you understand the security implications.
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There’s an extra leading space in the highlighted note line, which makes the section look mis-indented and inconsistent with other docs. Remove the leading spaces before **Input Validation:** so the paragraph aligns normally under the heading.

Suggested change
**Input Validation:** The scripts have been updated with input validation to prevent command injection vulnerabilities. Do not modify the validation code unless you understand the security implications.
**Input Validation:** The scripts have been updated with input validation to prevent command injection vulnerabilities. Do not modify the validation code unless you understand the security implications.

Copilot uses AI. Check for mistakes.
ahk/README.md Outdated
├── ControllerQuit.ahk # Quit apps with controller button combo
├── Fullscreen.ahk # Borderless fullscreen toggle
├── Keys.ahk # Comprehensive hotkey suite
├── Keys.ahk # hotkey suite
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description for Keys.ahk now has an extra leading space and drops the capitalized descriptor, resulting in "# hotkey suite". Fix the double space and keep consistent capitalization (e.g., "Hotkey suite").

Suggested change
├── Keys.ahk # hotkey suite
├── Keys.ahk # Hotkey suite

Copilot uses AI. Check for mistakes.
Comment on lines +420 to +429
Fully compatible - use any settings

### Multiplayer (Vanilla)
⚠️ Check server rules - many servers ban AFK machines
Check server rules - many servers ban AFK machines

### Multiplayer (Modded)
⚠️ Check for anti-cheat mods
Check for anti-cheat mods

### Realms
⚠️ May violate Microsoft ToS
May violate Microsoft ToS
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Server Compatibility section, the compatibility statements now start with two leading spaces (e.g., " Fully compatible...") which looks like accidental indentation and can affect markdown rendering/readability. Remove the leading spaces so these lines align with the headings.

Copilot uses AI. Check for mistakes.
@Ven0m0
Copy link
Copy Markdown
Owner

Ven0m0 commented Apr 3, 2026

@copilot apply changes based on the comments in this thread

…bel, symlink entries

Agent-Logs-Url: https://github.com/Ven0m0/Scripts/sessions/6f9b8192-906d-4d3c-9b93-6522a9c1aed6

Co-authored-by: Ven0m0 <82972344+Ven0m0@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 3, 2026

@copilot apply changes based on the comments in this thread

All six review comments addressed in abca968:

  • README.md — added CLAUDE.md and GEMINI.md to the Project Structure tree, noted as symlinks to AGENTS.md
  • Citra_per_game_config/README.md — fixed ** Important:****Important:**
  • Lib/README.md — fixed ** CRITICAL:****CRITICAL:**
  • Downloader/README.md — removed leading space before **Input Validation:**
  • ahk/README.md — fixed Keys.ahk label from # hotkey suite# Hotkey suite
  • ahk/Minecraft/README.md — removed leading spaces from all four Server Compatibility lines

Copilot AI requested a review from Ven0m0 April 3, 2026 15:55
@Ven0m0 Ven0m0 merged commit feb3858 into main Apr 3, 2026
5 of 7 checks passed
@Ven0m0 Ven0m0 deleted the copilot/cleanup-repository-structure branch April 3, 2026 16:19
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.

3 participants