brooklyn/kalmiya
Watch
1
0
Fork
You've already forked kalmiya
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: rewrite README from placeholder to project-specific #1

Merged
kalmiya merged 1 commit from docs/rewrite-readme into trunk 2026-07-17 10:33:11 -07:00
Conversation 0 Commits 1 Files changed 1 +179 -13
kalmiya commented 2026-07-17 10:31:14 -07:00
Collaborator
Copy link

What

Replaces the Rails generator boilerplate in README.md with a real on-ramp for the kalmiya repo.

Why

The previous README was 13 lines of "this would normally document…" and pointed readers at nothing. A new contributor landing here from the forge gets no signal about what this project is, what stack it's on, or how to run it.

What's in it

  • What this repo is — one-paragraph framing, scope (auth-only, no business models yet)
  • Stack table — every pinned version: Ruby 4.0.6, Rails 8.2.0.alpha, Postgres 18, React 19, Superglue 2-beta, Mantine 9, Propshaft, esbuild, PostCSS, Biome, Rubocop Omakase, Kamal
  • Quickstart — both devenv (recommended) and plain paths
  • Project layout — directory tree, route table from config/routes.rb
  • Superglue architecture note — calls out that this is not standard ERB; every page has an ERB shell + a .jsx Superglue page; points at @thoughtbot/superglue docs
  • Development commands — table covering bin/dev, bin/setup, Rubocop, Brakeman, Biome, Storybook
  • Testing — what's wired, what's commented out
  • CI — what bin/ci runs, plus the known issue with bin/importmap audit being a no-op
  • Deployment — Kamal + Thruster are pre-wired but no target host yet
  • Working agreement — solo-founder repo, trunk mainline, no PRs required (this one is an exception per the request that prompted it)
  • License — TBD / "all rights reserved" until LICENSE file is added

Cross-reference

AGENTS.md is the canonical project narrative — this README is the on-ramp, AGENTS.md is the deep dive. Linked at the bottom.

Known follow-ups

  • Add a LICENSE file (called out at the bottom of the new README)
  • Resolve the bin/importmap audit step in config/ci.rb (mentioned in the CI section)
## What Replaces the Rails generator boilerplate in `README.md` with a real on-ramp for the kalmiya repo. ## Why The previous README was 13 lines of "this would normally document…" and pointed readers at nothing. A new contributor landing here from the forge gets no signal about what this project is, what stack it's on, or how to run it. ## What's in it - **What this repo is** — one-paragraph framing, scope (auth-only, no business models yet) - **Stack table** — every pinned version: Ruby 4.0.6, Rails 8.2.0.alpha, Postgres 18, React 19, Superglue 2-beta, Mantine 9, Propshaft, esbuild, PostCSS, Biome, Rubocop Omakase, Kamal - **Quickstart** — both devenv (recommended) and plain paths - **Project layout** — directory tree, route table from `config/routes.rb` - **Superglue architecture note** — calls out that this is not standard ERB; every page has an ERB shell + a `.jsx` Superglue page; points at `@thoughtbot/superglue` docs - **Development commands** — table covering `bin/dev`, `bin/setup`, Rubocop, Brakeman, Biome, Storybook - **Testing** — what's wired, what's commented out - **CI** — what `bin/ci` runs, plus the known issue with `bin/importmap audit` being a no-op - **Deployment** — Kamal + Thruster are pre-wired but no target host yet - **Working agreement** — solo-founder repo, `trunk` mainline, no PRs required (this one is an exception per the request that prompted it) - **License** — TBD / "all rights reserved" until LICENSE file is added ## Cross-reference `AGENTS.md` is the canonical project narrative — this README is the on-ramp, AGENTS.md is the deep dive. Linked at the bottom. ## Known follow-ups - Add a LICENSE file (called out at the bottom of the new README) - Resolve the `bin/importmap audit` step in `config/ci.rb` (mentioned in the CI section)
docs: rewrite README from placeholder to project-specific
Some checks failed
CI / scan_ruby (pull_request) Failing after 0s
Details
CI / lint (pull_request) Failing after 0s
Details
CI / test (pull_request) Failing after 0s
Details
CI / system-test (pull_request) Failing after 0s
Details
4caaaab26c 
- Replaces Rails generator boilerplate with a real on-ramp
- Documents stack, devenv vs plain setup paths, project layout
- Adds Superglue architecture note (every page = ERB shell + .jsx page)
- Surfaces known issue: bin/importmap audit step in config/ci.rb is a no-op
- Cross-references AGENTS.md as canonical project narrative
kalmiya merged commit db390b2a2e into trunk 2026-07-17 10:33:11 -07:00
kalmiya deleted branch docs/rewrite-readme 2026-07-17 10:33:17 -07:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
brooklyn/kalmiya!1
No description provided.