Skip to content

Fill README gaps: demo placeholder, architecture diagram, stretch specs#1

Merged
dadachi merged 1 commit intomainfrom
readme-demo-arch-specs
Apr 20, 2026
Merged

Fill README gaps: demo placeholder, architecture diagram, stretch specs#1
dadachi merged 1 commit intomainfrom
readme-demo-arch-specs

Conversation

@dadachi
Copy link
Copy Markdown
Contributor

@dadachi dadachi commented Apr 20, 2026

Summary

  • Add a Demo section with a placeholder for the post-hackathon 90-second video
  • Add an Architecture section with a Mermaid flowchart (spec → agent → substrate copy → output → three validation layers)
  • Extend the CLI usage example with the two stretch specs (restaurant waitlist, personal task tracker) alongside the must-have clinic-queue example

Why

Closes the three remaining items in §2.3 of the pre-hackathon prep checklist. Hackathon runs April 21–27; the public README is what reviewers land on when searching for the project, so these gaps need to be filled before Tuesday morning.

Test plan

  • Mermaid diagram renders correctly on GitHub's PR preview (no syntax errors)
  • All three existing README anchors still work (#substrate, #usage-target-interface, #validation-three-layers)
  • No broken internal links to docs/SPEC.md, ROADMAP.md, CLAUDE.md, LICENSE

🤖 Generated with Claude Code

Addresses §2.3 of the pre-hackathon checklist — the public README is the
first thing reviewers see, so the three checklist items (example specs
beyond the must-have clinic queue, architecture visual, demo placeholder)
need to land before Tuesday.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dadachi dadachi merged commit f7522ea into main Apr 20, 2026
@dadachi dadachi deleted the readme-demo-arch-specs branch April 20, 2026 12:13
dadachi added a commit that referenced this pull request Apr 21, 2026
Day-3a's lexical rename handled the domain entities (Shop->Clinic etc.)
but left the substrate's product-name references (Nativeapptemplateapi
module, NativeAppTemplate brand) intact. Generated projects reused
the substrate's actual dev/test databases because config/database.yml
still said `nativeapptemplateapi_development`. Tue-evening probe
accidentally dropped the user's substrate DBs on cleanup.

Fix:
- src/agents/workers/rails.ts: synthesize two product-rename pairs
  from the slug and prepend them to the planner's domain plan.
  {Nativeapptemplateapi -> <Slug>Api} scopes the Rails module, DB
  names, render config. {NativeAppTemplate -> <Slug>} handles
  brand/URL references in settings/openapi/envs.
- scripts/ruby/rename.rb: add flat-lowercase patterns for tokens
  that don't re-appear in snake form (e.g. `nativeapptemplate.com`,
  `com.yourdomain.nativeapptemplate`). Runs AFTER snake so single-
  word rename pairs where flat == snake (e.g. `shop`) can't win
  over snake's replacement.

Verified on both specs:
  clinic-queue: module ClinicQueueApi, database
    clinic_queue_api_development, zero leftover
    NativeAppTemplate/nativeapptemplate/Nativeapptemplateapi tokens.
  task-tracker: module TaskTrackerApi, database
    task_tracker_api_development.

Full `bin/rails test` on generated clinic-queue project:
  405 runs, 814 assertions, 0 failures, 0 errors, 0 skips.
Substrate databases NOT touched (confirmed post-run).

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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