bytelyst-devops-tools/docs/repo-map.md

149 lines
3.1 KiB
Markdown

# Repository Map
High-level map of the repository for contributors and AI agents.
## Top Level
### Core Bash Tooling
- `bytelyst-cli.sh`
- Main CLI entry point for common GitHub operations.
- `remove_user_interactive.sh`
- Interactive collaborator removal across matching repositories.
- `remove_user_guided.sh`
- Guided UX wrapper for the removal workflow.
- `remove_user_from_repos.sh`
- Non-guided removal script.
- `delete_team_interactive.sh`
- Interactive team deletion.
- `make_repos_private.sh`
- Repository visibility changes.
- `list_*.sh`
- Read-oriented listing and reporting utilities.
### Supporting Data And Inputs
- `github_repos.json`
- `github_acc_input.json`
- `repos.json`
- `repos.txt`
- `users_white_list.json`
- `users_black_list.json`
- account snapshot JSON files in the root
These are operational inputs or snapshots, not general-purpose source files.
## Directories
### `docs/`
Canonical onboarding and repo navigation docs.
Current key files:
- `docs/getting-started.md`
- `docs/repo-map.md`
- `docs/tooling-status.md`
- `docs/remove_user_interactive.md`
### `git-work-safety-tools/`
Scripts for scanning many git repositories and performing safer bulk workflows.
Key files:
- `git_repos_status.sh`
- `git_repos_rebase_commit_push.sh`
- `multi_repo_safe_push.sh`
- `multi_repo_status.sh`
- `multi_repo_interactive_fix.sh`
### `scripts/`
Self-contained operational scripts that do not fit the older root-level naming pattern.
Key files:
- `ubuntu-vm-security-update.sh`
- `README.md`
### `github_access_scripts/`
Focused GitHub access checks.
Key files:
- `check_repo_access.sh`
- `list_user_repos.sh`
### `github_repo_scanners/`
Repo scanning scripts plus generated JSON outputs.
Key files:
- `create_user_repo_lists.sh`
- `create_contributor_repo_lists.sh`
- `run_contributor_json_creation.sh`
- `contributor_repos/*.json`
### `Slack Message/`
Python Slack CLI utility.
Key files:
- `slack_poster.py`
- `README.md`
- `requirements.txt`
### `youtube/`
YouTube transcript and summarization utilities.
Key files:
- `transcribe_yt_video.py`
- `enhanced_yt_transcript.py`
- `summarize_with_perplexity.py`
- `README_youtube_transcripts.md`
- `captions/`
- `prompts/`
### `supabase monitor/`
Separate Python workflow project for YouTube processing. The folder name is misleading; inspect local docs before changing code.
Key files:
- `README.md`
- `EXECUTION_GUIDE.md`
- `workflow.py`
- `api.py`
- `agents/`
- `utils/`
- `output/`
### `_AZURE/`
Account-specific notes and operational docs.
Treat contents as environment-specific documentation rather than core project source.
## Legacy Docs
These still exist but are no longer the best starting point:
- `README_interactive_script.md`
- `README_remove_user_script.md`
Prefer `docs/` for new canonical documentation.
## Cleanup Guidance
When cleaning this repo:
- do not delete tracked outputs or snapshots unless explicitly asked
- prefer adding orientation docs over moving operational files
- avoid renaming legacy scripts unless you also provide compatibility shims or update all references