# Index of hackathon

Every file in this repo with a one-line description taken from the file itself. Generated by `scripts/build_index.py`; run `make index` after adding files, never edit by hand.

## Top level (13)

| File | What it is |
|---|---|
| [.editorconfig](.editorconfig) |  |
| [.gitignore](.gitignore) | Secrets and private material never belong here |
| [AGENTS.md](AGENTS.md) | Hackathon Context: instructions for every agent |
| [CHANGELOG.md](CHANGELOG.md) | Changelog |
| [CLAUDE.md](CLAUDE.md) | Mandatory architecture and handoff direction |
| [CONTRIBUTING.md](CONTRIBUTING.md) | Contributing |
| [DISCLAIMER.md](DISCLAIMER.md) | Disclaimer |
| [LICENSE](LICENSE) | MIT License |
| [MOVED.md](MOVED.md) | Moved here on October 29, 2026 |
| [Makefile](Makefile) |  |
| [README.md](README.md) | Hackathon Context: clone-able kit for the Meta Global AI Developer Hackathon |
| [SECURITY.md](SECURITY.md) | Security |
| [keywords.txt](keywords.txt) | Terms for KEYWORDS.md, one per line: "term" or "term: alias, alias". |

## agents/ (14)

| File | What it is |
|---|---|
| [agents/AGENTS.template.md](agents/AGENTS.template.md) | <Project>: instructions for every coding agent |
| [agents/CLAUDE.template.md](agents/CLAUDE.template.md) | Mandatory architecture and handoffs |
| [agents/README.md](agents/README.md) | Agent templates |
| [agents/claude/agents/reviewer.md](agents/claude/agents/reviewer.md) | Gather |
| [agents/claude/guard.example.json](agents/claude/guard.example.json) | JSON object: allow, deny_read, deny_write, deny_commands |
| [agents/claude/hooks/format.py](agents/claude/hooks/format.py) | Claude Code PostToolUse hook: format the file that was just edited. |
| [agents/claude/hooks/guard.py](agents/claude/hooks/guard.py) | Claude Code PreToolUse guard: enforces the hard rules in every permission mode. |
| [agents/claude/settings.template.json](agents/claude/settings.template.json) | JSON object: $schema, permissions, hooks |
| [agents/claude/skills/brief/SKILL.md](agents/claude/skills/brief/SKILL.md) | --- |
| [agents/muse/README.md](agents/muse/README.md) | Muse Code: running workers safely |
| [agents/muse/settings.example.json](agents/muse/settings.example.json) | JSON object: schema_version, agents |
| [agents/schemas/architecture.schema.json](agents/schemas/architecture.schema.json) | Repository architecture |
| [agents/schemas/brief.schema.json](agents/schemas/brief.schema.json) | Task brief |
| [agents/schemas/receipt.schema.json](agents/schemas/receipt.schema.json) | Task receipt |

## event/ (17)

| File | What it is |
|---|---|
| [event/01-overview.md](event/01-overview.md) | Overview |
| [event/02-key-dates.md](event/02-key-dates.md) | Key dates |
| [event/03-tracks.md](event/03-tracks.md) | Tracks |
| [event/04-themes.md](event/04-themes.md) | Themes |
| [event/05-problem-statements.md](event/05-problem-statements.md) | Problem statements |
| [event/06-eligibility.md](event/06-eligibility.md) | Eligibility |
| [event/07-official-rules-summary.md](event/07-official-rules-summary.md) | Official Rules, section by section |
| [event/08-judging.md](event/08-judging.md) | Judging |
| [event/09-prizes-and-payout.md](event/09-prizes-and-payout.md) | Prizes and payout |
| [event/10-credits.md](event/10-credits.md) | Credits |
| [event/11-submission.md](event/11-submission.md) | Submission |
| [event/12-models-and-tools.md](event/12-models-and-tools.md) | Models and tools |
| [event/13-acceptable-use-and-data.md](event/13-acceptable-use-and-data.md) | Acceptable use, data use and geography |
| [event/14-communications.md](event/14-communications.md) | Communications |
| [event/15-schedule-and-workshops.md](event/15-schedule-and-workshops.md) | Schedule and workshops |
| [event/16-faq.md](event/16-faq.md) | FAQ (unofficial) |
| [event/README.md](event/README.md) | Meta Global AI Developer Hackathon at a glance |

## events/ (2)

| File | What it is |
|---|---|
| [events/2026-10-26-kickoff.md](events/2026-10-26-kickoff.md) | Kickoff livestream, Oct 26, 2026 (template, to fill) |
| [events/README.md](events/README.md) | Session notes |

## guides/ (11)

| File | What it is |
|---|---|
| [guides/README.md](guides/README.md) | Guides |
| [guides/agent-recovery-and-review.md](guides/agent-recovery-and-review.md) | Typed agent recovery and lightweight review |
| [guides/agent-workflow.md](guides/agent-workflow.md) | Agent workflow |
| [guides/compliance-checklist.md](guides/compliance-checklist.md) | Compliance checklist |
| [guides/external-agent-access.md](guides/external-agent-access.md) | How an external agent connects: anonymous vs keyed |
| [guides/hosting.md](guides/hosting.md) | Hosting: local first, then a permanent address |
| [guides/nouns-and-verbs.md](guides/nouns-and-verbs.md) | Nouns and verbs in one minute |
| [guides/reviewable-repo.md](guides/reviewable-repo.md) | A reviewable repo |
| [guides/ten-day-plan.md](guides/ten-day-plan.md) | A ten-day plan |
| [guides/worker-first-execution.md](guides/worker-first-execution.md) | Worker-first execution and private work |
| [guides/worker-verb-examples.md](guides/worker-verb-examples.md) | Work suitable for claimed verbs |

## meta-platform/ (7)

| File | What it is |
|---|---|
| [meta-platform/README.md](meta-platform/README.md) | Meta platform notes |
| [meta-platform/astryx.md](meta-platform/astryx.md) | Astryx |
| [meta-platform/model-api.md](meta-platform/model-api.md) | Meta Model API |
| [meta-platform/models-and-pricing.md](meta-platform/models-and-pricing.md) | Models, prices and limits |
| [meta-platform/muse-code.md](meta-platform/muse-code.md) | Muse Code |
| [meta-platform/open-weights-and-safety-tools.md](meta-platform/open-weights-and-safety-tools.md) | Open weights and safety tools |
| [meta-platform/speech-to-text.md](meta-platform/speech-to-text.md) | Speech to text (Muse Voice Transcribe) |

## observations/ (2)

| File | What it is |
|---|---|
| [observations/2026-10-26-day-one.md](observations/2026-10-26-day-one.md) | Day one: inconsistencies and gotchas |
| [observations/README.md](observations/README.md) | Observations and comments |

## scripts/ (10)

| File | What it is |
|---|---|
| [scripts/README.md](scripts/README.md) | Scripts |
| [scripts/bootstrap-hosting.sh](scripts/bootstrap-hosting.sh) | One-time hosting setup for one service on Fly.io behind a Cloudflare Worker: the Fly app and its |
| [scripts/bootstrap-workspace.sh](scripts/bootstrap-workspace.sh) | Clone this kit and your own repos side by side into one workspace folder. |
| [scripts/build_index.py](scripts/build_index.py) | Build this repo's indexes from its own files. |
| [scripts/check-prereqs.sh](scripts/check-prereqs.sh) | Report whether the tools the project needs are installed. |
| [scripts/check_architecture.py](scripts/check_architecture.py) | Check that architecture.json still describes this repo truthfully. |
| [scripts/check_docs.py](scripts/check_docs.py) | Check that every JSON file parses and every relative Markdown link resolves. |
| [scripts/check_public.py](scripts/check_public.py) | Fail if a file headed for a public repo holds a secret or a private name. |
| [scripts/install-muse-code.sh](scripts/install-muse-code.sh) | Install Meta's Muse Code CLI the careful way: download the official installer, show what it is, then run it o… |
| [scripts/test_scripts.py](scripts/test_scripts.py) | Tests for the shared scripts: the architecture check, the leak scan and the index builder's link base. |

## templates/ (16)

| File | What it is |
|---|---|
| [templates/README.md](templates/README.md) | Templates |
| [templates/brief.example.json](templates/brief.example.json) | B4: Rate-limit the public submit endpoint and answer 429 with Retry-After |
| [templates/demo-video-checklist.md](templates/demo-video-checklist.md) | Demo video checklist |
| [templates/observation-entry.md](templates/observation-entry.md) | YYYY-MM-DD: topic |
| [templates/receipt.example.json](templates/receipt.example.json) | JSON object: task_id, worker, fencing_token, receipt_hash, started_at, finished_at |
| [templates/review/ARCHITECTURE.md](templates/review/ARCHITECTURE.md) | <Project>: architecture |
| [templates/review/COMPARISON.md](templates/review/COMPARISON.md) | <Project>: comparison |
| [templates/review/DECISIONS.md](templates/review/DECISIONS.md) | <Project>: decisions |
| [templates/review/GENERALIZING.md](templates/review/GENERALIZING.md) | <Project>: generalizing it |
| [templates/review/GLOSSARY.md](templates/review/GLOSSARY.md) | <Project>: glossary |
| [templates/review/README.md](templates/review/README.md) | Review doc templates |
| [templates/review/REVIEW.md](templates/review/REVIEW.md) | <Project>: review guide |
| [templates/review/SETUP.md](templates/review/SETUP.md) | <Project>: setup |
| [templates/review/SUMMARY.md](templates/review/SUMMARY.md) | <Project>: summary |
| [templates/review/architecture.example.json](templates/review/architecture.example.json) | my-app |
| [templates/submission-description.md](templates/submission-description.md) | <Project name>: submission description (template) |

## tools/ (3)

| File | What it is |
|---|---|
| [tools/transcribe/README.md](tools/transcribe/README.md) | transcribe: Muse Voice Transcribe for long WAV files |
| [tools/transcribe/test_transcribe.py](tools/transcribe/test_transcribe.py) | Tests for transcribe.py. |
| [tools/transcribe/transcribe.py](tools/transcribe/transcribe.py) | Transcribe a WAV file you have the right to use with Meta's Muse Voice Transcribe. |