Skip to content

Rewrite the README for users - #148

Merged
skyfallwastaken merged 1 commit into
neofrom
readme
Sep 26, 2026
Merged

skyfallwastaken merged 1 commit into
neofrom
readme

Conversation

@skyfallwastaken

Copy link
Copy Markdown
Member

The README was a developer runbook for the rewrite: datastore ports, migration rules, test internals, the route table, and notes about the old gateway. It's now a short page for people who want to use Hack Club AI:

  • what it is, with links to the site and docs;
  • three steps to get started, with Python and curl examples;
  • a table of the available endpoints;
  • a small Contributing section.

Nothing is lost. The development content moved to docs/development.md (setup, commands, tests, migrations, production requirements, and the full route table), cleaned of outdated lines. For example, the old "503 until EXA_API_KEY is set" contradicted the "every key is required" rule. AGENTS.md / CLAUDE.md now point there for setup.

docs/ is gitignored, so docs/development.md is force-added, like docs/architecture/storage-and-billing.md.

Screenshots

Before (neo) After
before after

Rendered on this branch: README.md 路 docs/development.md

馃 Generated with Claude Code

@skyfallwastaken
skyfallwastaken merged commit ad1beea into neo Sep 26, 2026
3 checks passed
@skyfallwastaken
skyfallwastaken deleted the readme branch September 26, 2026 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant