Skip to content

Commit feb3858

Browse files
CopilotVen0m0
andauthored
Repository cleanup: docs separation, structure accuracy, content hygiene (#50)
* docs: separate code from docs, create docs/ folder, remove sprawl, fix 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> * docs: clean all markdown files - remove emojis, promotional language, 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> * docs: update CLAUDE.md refs to AGENTS.md, fix double spaces from word 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> * docs: fix review feedback - bold markers, leading spaces, Keys.ahk label, 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> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Ven0m0 <82972344+Ven0m0@users.noreply.github.com>
1 parent 425dcd5 commit feb3858

14 files changed

Lines changed: 127 additions & 409 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 146 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This project follows a simple code of conduct: be respectful, constructive, and
5151
```
5252
Scripts/
5353
├── ahk/ # AutoHotkey v2 scripts
54-
├── Lib/ # Shared libraries (v1 and v2)
54+
├── Lib/ # Shared libraries (v2)
5555
├── Other/ # Specialized utilities
5656
├── .github/ # CI/CD workflows and instructions
5757
└── docs/ # Additional documentation
@@ -104,11 +104,11 @@ Add header comments to all scripts:
104104
; Author: Your Name
105105
; Version: 1.0.0
106106
; Last Updated: YYYY-MM-DD
107-
;
107+
;
108108
; Requirements:
109109
; - AutoHotkey v2.0+
110110
; - Admin privileges (if needed)
111-
;
111+
;
112112
; Usage:
113113
; Brief usage instructions
114114
; =============================================================================
@@ -255,7 +255,7 @@ monitor as primary display.
255255

256256
- [ ] Code follows the style guidelines
257257
- [ ] Comments added for complex logic
258-
- [ ] Documentation updated (README, CLAUDE.md, etc.)
258+
- [ ] Documentation updated (README, AGENTS.md, etc.)
259259
- [ ] No trailing whitespace
260260
- [ ] CRLF line endings for `.ahk` files
261261
- [ ] Scripts tested locally
@@ -321,7 +321,7 @@ Update documentation when you:
321321
### Documentation Files
322322

323323
- **README.md** - User-facing overview and quick start
324-
- **CLAUDE.md** - Developer guide and AI assistant instructions
324+
- **AGENTS.md** - Developer guide and AI assistant instructions
325325
- **CONTRIBUTING.md** - This file
326326
- **Directory READMEs** - Specific documentation for subdirectories
327327
- **Inline comments** - Complex logic and function documentation
@@ -341,13 +341,13 @@ Update documentation when you:
341341

342342
- [AutoHotkey Documentation](https://www.autohotkey.com/docs/)
343343
- [AutoHotkey Forum](https://www.autohotkey.com/boards/)
344-
- [CLAUDE.md](CLAUDE.md) - Comprehensive development guide
344+
- [AGENTS.md](AGENTS.md) - development guide
345345
- [GitHub Issues](https://github.com/Ven0m0/Scripts/issues)
346346

347347
### Asking Questions
348348

349349
- Check existing [Issues](https://github.com/Ven0m0/Scripts/issues)
350-
- Read [CLAUDE.md](CLAUDE.md) for common patterns
350+
- Read [AGENTS.md](AGENTS.md) for common patterns
351351
- Open a new issue with:
352352
- Clear description
353353
- Steps to reproduce (for bugs)
@@ -362,4 +362,4 @@ Contributors will be acknowledged in:
362362
- Release notes
363363
- Project README (for significant contributions)
364364

365-
Thank you for contributing! 🎉
365+
Thank you for contributing!

Lib/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ InitScript(true, true) ; Require Admin + Performance optimization (UIA built-in
6161

6262
**Functions:**
6363

64-
- `ToggleFakeFullscreenMultiMonitor(winTitle)` ⭐ Most used
64+
- `ToggleFakeFullscreenMultiMonitor(winTitle)` — most used
6565
- Multi-monitor aware borderless fullscreen toggle
6666
- Detects current monitor and calculates bounds
6767
- Saves/restores window state
@@ -268,7 +268,7 @@ WinWait("ahk_exe game.exe")
268268

269269
## Testing Library Changes
270270

271-
**⚠️ CRITICAL:** Changes to library files affect ALL dependent scripts!
271+
**CRITICAL:** Changes to library files affect ALL dependent scripts!
272272

273273
### Testing Process
274274

@@ -292,7 +292,7 @@ WinWait("ahk_exe game.exe")
292292
- New required parameters
293293

294294
4. **Update documentation:**
295-
- CLAUDE.md
295+
- AGENTS.md
296296
- This README
297297
- Inline comments
298298

@@ -360,14 +360,14 @@ When modifying library files:
360360
1. **Document all changes** in function headers
361361
2. **Test thoroughly** with dependent scripts
362362
3. **Update version-specific libraries** (v1 and v2)
363-
4. **Update CLAUDE.md** with changes
363+
4. **Update AGENTS.md** with changes
364364
5. **Add migration notes** if breaking changes
365365

366366
See [CONTRIBUTING.md](../CONTRIBUTING.md) for detailed guidelines.
367367

368368
## Additional Resources
369369

370-
- [CLAUDE.md](../CLAUDE.md) - Comprehensive developer guide
370+
- [AGENTS.md](../AGENTS.md) - developer guide
371371
- [AutoHotkey v1 Documentation](https://www.autohotkey.com/docs/v1/)
372372
- [AutoHotkey v2 Documentation](https://www.autohotkey.com/docs/v2/)
373373
- [v1 to v2 Migration Guide](https://www.autohotkey.com/docs/v2/v2-changes.htm)

Links.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

Other/7zEmuPrepper/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,14 @@ Pass additional parameters to the emulator:
128128

129129
## Trade-offs
130130

131-
### Advantages
131+
### Advantages
132132

133133
- **Huge space savings** (50-80% reduction)
134134
- **No manual decompression** needed
135135
- **Original archives remain intact**
136136
- **Works with any emulator**
137137

138-
### Disadvantages
138+
### Disadvantages
139139

140140
- **Longer launch time** (depends on game size and CPU)
141141
- **Requires disk space** for temporary extraction

Other/Citra_per_game_config/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Other/Citra_per_game_config/
7272
└── tf.ahk # REQUIRED - Do not delete!
7373
```
7474

75-
**⚠️ Important:** `tf.ahk` must be in the same folder as the other scripts!
75+
**Important:** `tf.ahk` must be in the same folder as the other scripts!
7676

7777
### Step 3: Backup Original Config
7878

Other/Downloader/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,18 @@ This directory contains AutoHotkey v1 scripts that provide a user-friendly graph
5656
```bash
5757
# Place these files in Other/Downloader/:
5858
- yt-dlp.exe
59-
- spotdl.exe (renamed from spotdl-*.exe)
60-
- ffmpeg.exe (run update.cmd or download manually)
59+
- spotdl.exe (renamed from spotdl-*.exe)
60+
- ffmpeg.exe (run update.cmd or download manually)
6161
```
6262

6363
2. **Verify file structure:**
6464
```
6565
Other/Downloader/
6666
├── YT_Spotify_Downloader.ahk
6767
├── update.cmd
68-
├── yt-dlp.exe ← Download this
69-
├── spotdl.exe ← Download and rename this
70-
└── ffmpeg.exe ← Run update.cmd or download
68+
├── yt-dlp.exe ← Download this
69+
├── spotdl.exe ← Download and rename this
70+
└── ffmpeg.exe ← Run update.cmd or download
7171
```
7272

7373
3. **Run the downloader:**
@@ -247,7 +247,7 @@ update.cmd
247247

248248
## Security Note
249249

250-
⚠️ **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.
250+
**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.
251251

252252
```autohotkey
253253
; Security feature - do not remove

0 commit comments

Comments
 (0)