2026-02-23 20:18:42 -08:00
1 changed files with 86 additions and 0 deletions
@@ -0,0 +1,86 @@
+# Documentation TODO
+
+## Plan
+
+Add a `README.md` to each script category folder. Each README should document every script in that folder with:
+- What the script does (1-2 sentences)
+- Data files required (filename, what it contains, where to put it - top-level `data/`)
+- Environment variables required
+
+## Categories to Document
+
+### TypeScript
+
+- `typescript/src/crowdin/README.md`
+  - `clearHiddenTranslations.ts`
+  - `reapplyTranslations.ts`
+  - `writeData.ts`
+
+- `typescript/src/discord/README.md`
+  - `cycThreads.ts`
+  - `guildCount.ts`
+
+- `typescript/src/discourse/README.md`
+  - `bulkUpdateCategories.ts`
+  - `closeOldTopics.ts`
+
+- `typescript/src/gitea/README.md`
+  - `deleteFromAllRepos.ts`
+  - `uploadToAllRepos.ts`
+  - `uploadToReposConditionally.ts`
+
+- `typescript/src/github/README.md`
+  - `auditNpmPackages.ts`
+  - `onboardMentee.ts`
+  - `postUserStories.ts`
+
+- `typescript/src/music/README.md`
+  - `id3v2.ts`
+
+- `typescript/src/s3/README.md`
+  - `bulkUpload.ts`
+  - `correctContentType.ts`
+  - `deleteContents.ts`
+  - `upload.ts`
+
+- `typescript/src/security/README.md`
+  - `generateReport.ts`
+
+### Python
+
+- `python/cohort/README.md`
+  - `add_github_team_members.py`
+  - `analyse_availability.py`
+  - `assign_cohort_role.py`
+  - `assign_team_roles.py`
+  - `catch_up_report.py`
+  - `check_channel_permissions.py`
+  - `check_lengths.py`
+  - `check_member_status.py`
+  - `create_team_voice_channels.py`
+  - `discord_activity_checker.py`
+  - `evaluate_technical_proficiency.py`
+  - `fetch_roster.py`
+  - `fix_channel_permissions.py`
+  - `generate_member_files.py`
+  - `generate_timeslots.py`
+  - `get_cohort_members.py`
+  - `list_all_guild_roles.py`
+  - `list_discord_roles.py`
+  - `remove_discord_roles.py`
+  - `remove_member.py`
+  - `remove_resigned_members.py`
+  - `send_activity_report.py`
+  - `send_checkin.py`
+  - `send_team_checkin.py`
+  - `send_team_messages.py`
+  - `update_cohort_leads_permissions.py`
+  - `update_roster_messages.py`
+  - `verify_discord.py`
+
+## Notes
+
+- All data files go in the top-level `data/` directory
+- Python scripts resolve `data/` via `DATA_DIR = Path(__file__).parent.parent.parent / "data"`
+- TypeScript scripts resolve `data/` via `join(import.meta.dirname, "..", "..", "data")`
+- Each README should have a quick "Getting Started" section explaining how to run scripts (via `run.sh` or the Makefile)