Repository structure (reference)
Quick reference for the most important files and folders in this repository.
README.md
— project overview and quick linksdocs/
— user-facing documentation (this folder)_prompts/
— prompt definitions used by agents_instructions/
— instruction files withapplyTo
rules for automated agentsscripts/
— Python utilities and automation scriptsrequirements.txt
— Python dependencies used by the scriptsrepo_recommender.py
,scan_starred_repos.py
— main example scripts
data/
— sample datasets and example outputsresults/
— example outputs and run artifacts (may be gitignored).github/
— CI workflows, GitHub Actions and project automationworkflows/
— contains e.g.jekyll-gh-pages.yml
for site publishing
docs/
— documentation pages for GitHub Pages / site
Commands
- Run tests (if provided): see
tests/
andplaywright.config.ts
for end-to-end checks. - Install Python dependencies for scripts:
pip install -r scripts/requirements.txt
Environment & secrets
- The repository uses environment variables for any external integrations. Never commit secrets — read
security-and-owasp.instructions.md
for guidance.