Repository cleanup: docs separation, structure accuracy, content hygiene#50
Repository cleanup: docs separation, structure accuracy, content hygiene#50
Conversation
…x README Agent-Logs-Url: https://github.com/Ven0m0/Scripts/sessions/a3ecb70b-c594-4d72-9cf1-11328b280f9e Co-authored-by: Ven0m0 <82972344+Ven0m0@users.noreply.github.com>
… minimize whitespace Agent-Logs-Url: https://github.com/Ven0m0/Scripts/sessions/a3ecb70b-c594-4d72-9cf1-11328b280f9e Co-authored-by: Ven0m0 <82972344+Ven0m0@users.noreply.github.com>
… removal Agent-Logs-Url: https://github.com/Ven0m0/Scripts/sessions/a3ecb70b-c594-4d72-9cf1-11328b280f9e Co-authored-by: Ven0m0 <82972344+Ven0m0@users.noreply.github.com>
Code Review SummaryStatus: No Issues Found | Recommendation: Merge Files Reviewed (6 files)
Incremental Changes (Fixed Issues)All 6 issues from the previous review have been resolved:
SummaryDocumentation-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 |
There was a problem hiding this comment.
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 movedEXAMPLES.mdthere; removedCHANGELOG.mdandLinks.md. - Updated
README.mdto 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 |
There was a problem hiding this comment.
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.
| ├── 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 |
| ``` | ||
|
|
||
| **⚠️ 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! |
There was a problem hiding this comment.
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).
| ** 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! |
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! |
There was a problem hiding this comment.
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).
| ** CRITICAL:** Changes to library files affect ALL dependent scripts! | |
| **CRITICAL:** Changes to library files affect ALL dependent scripts! |
Other/Downloader/README.md
Outdated
| ## 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. |
There was a problem hiding this comment.
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.
| **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. |
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 |
There was a problem hiding this comment.
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").
| ├── Keys.ahk # hotkey suite | |
| ├── Keys.ahk # Hotkey suite |
ahk/Minecraft/README.md
Outdated
| 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 |
There was a problem hiding this comment.
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 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>
All six review comments addressed in abca968:
|
Six-pass cleanup: separate docs from code, fix stale structure references, remove sprawl, and enforce content standards across all markdown.
Docs separation
docs/and movedEXAMPLES.mdthereCHANGELOG.md(one-time migration log, not a maintained changelog) andLinks.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; onlyLib/v2/present)Other/Playnite_fullscreen_v2/Playnite_TV.ahk→Other/playnite-all.ahkGUI_PC.ahk,GUI_Laptop.ahk→GUI.ahk)Content hygiene (13 markdown files)
Applied across all user-facing docs, excluding AI instruction files (
AGENTS.md,CLAUDE.md,GEMINI.md):CLAUDE.mdreferences →AGENTS.md(canonical per repo guidance)