fix: update docs from Vite to Rails 8 stack #9

Merged
ldraney merged 2 commits from 8-fix-rails-8-docs into main 2026-06-19 04:16:33 +00:00
Owner

Summary

  • Replace all Vite + vanilla HTML/CSS/JS + nginx references with Rails 8 + Hotwire + Importmap Rails + Propshaft + Puma across documentation and README
  • Remove .claude-no-enforce sentinel file and add .gitignore

Changes

  • docs/architecture.md: Tech stack table replaced Vite/vanilla/nginx rows with Rails 8/Hotwire/Importmap Rails/Propshaft/Puma. Deployment pipeline diagram updated Build Vite -> rails asset:precompile, Docker nginx -> Docker Puma. Request flow diagram updated nginx Pod -> Puma Pod, /drake/index.html -> Rails router -> /drake.
  • docs/user-stories.md: Creator experience acceptance criterion changed "vite dev" to "rails server"
  • README.md: Stack section updated to Rails 8 stack. Quick Start changed npm install/npm run dev to bundle install/bin/rails server. (CLAUDE.md is a symlink, updates automatically.)
  • .claude-no-enforce: Deleted via git rm
  • .gitignore: Created with .claude-no-enforce entry

Test Plan

  • Review each changed file for correct Rails 8 terminology
  • Verify CLAUDE.md symlink still resolves to updated README.md
  • Confirm no application code or Gemfile was added (docs-only change)
  • No regressions in other documentation files

Review Checklist

  • Passed automated review-fix loop
  • No secrets committed
  • No unnecessary file changes
  • Commit messages are descriptive
  • Feature flag needed? No — docs-only change, no code paths affected
  • Closes #8 — Fix architecture docs: Rails 8 stack, not Vite + remove .claude-no-enforce
  • my-vibes-world — the project this work belongs to
## Summary - Replace all Vite + vanilla HTML/CSS/JS + nginx references with Rails 8 + Hotwire + Importmap Rails + Propshaft + Puma across documentation and README - Remove .claude-no-enforce sentinel file and add .gitignore ## Changes - **docs/architecture.md**: Tech stack table replaced Vite/vanilla/nginx rows with Rails 8/Hotwire/Importmap Rails/Propshaft/Puma. Deployment pipeline diagram updated Build Vite -> rails asset:precompile, Docker nginx -> Docker Puma. Request flow diagram updated nginx Pod -> Puma Pod, /drake/index.html -> Rails router -> /drake. - **docs/user-stories.md**: Creator experience acceptance criterion changed "vite dev" to "rails server" - **README.md**: Stack section updated to Rails 8 stack. Quick Start changed npm install/npm run dev to bundle install/bin/rails server. (CLAUDE.md is a symlink, updates automatically.) - **.claude-no-enforce**: Deleted via git rm - **.gitignore**: Created with .claude-no-enforce entry ## Test Plan - [ ] Review each changed file for correct Rails 8 terminology - [ ] Verify CLAUDE.md symlink still resolves to updated README.md - [ ] Confirm no application code or Gemfile was added (docs-only change) - [ ] No regressions in other documentation files ## Review Checklist - [ ] Passed automated review-fix loop - [ ] No secrets committed - [ ] No unnecessary file changes - [ ] Commit messages are descriptive - [ ] Feature flag needed? No — docs-only change, no code paths affected ## Related Notes - Closes #8 — Fix architecture docs: Rails 8 stack, not Vite + remove .claude-no-enforce - `my-vibes-world` — the project this work belongs to
Replace Vite + vanilla HTML/CSS/JS + nginx references with Rails 8 +
Hotwire + Importmap Rails + Propshaft + Puma across architecture docs,
user stories, and README. Remove .claude-no-enforce and add .gitignore.

Closes #8

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Author
Owner

PR #9 Review

DOMAIN REVIEW

Tech stack identified: Documentation only (Markdown, Mermaid diagrams). No application code changed.

The PR replaces Vite + vanilla HTML/CSS/JS + nginx references with Rails 8 + Hotwire + Importmap Rails + Propshaft + Puma across three documentation files, deletes the .claude-no-enforce sentinel, and adds a .gitignore. All changes are consistent with the stated goal.

Verified:

  • CLAUDE.md is a symlink to README.md -- updates propagate automatically as the PR body claims.
  • No application code (Gemfile, controllers, etc.) exists in the repo yet -- this is purely a docs-ahead-of-code update, which is appropriate for the project phase.
  • Tech stack table in docs/architecture.md correctly replaces 3 Vite-era rows (Build/Markup/Server) with 4 Rails-era rows (Framework/Frontend/JS Imports/Assets/Server). Row count change is intentional and correct.
  • Deployment pipeline and request flow Mermaid diagrams updated consistently (Build Vite -> rails asset:precompile, Docker nginx -> Docker Puma, nginx Pod -> Puma Pod).

BLOCKERS

None.

This is a docs-only change. No code paths, no user input handling, no secrets, no test coverage requirements apply.

NITS

  1. README.md "Adding a Vibe" section not updated (line 25 on main): Still reads Create a new directory under src/vibes/ with an index.html. Under Rails 8, vibes would use Rails conventions (routes, controllers, views), not raw directories with index.html files. This section is now inconsistent with the updated Stack and Quick Start sections directly above it.

  2. docs/architecture.md "Page Anatomy" section not updated (lines 64-66 on main): Still says "Its own index.html, styles, and scripts" and "Can import from shared utilities." Under Rails 8, pages would be views rendered by controllers, not standalone HTML files. Inconsistent with the updated tech stack table.

  3. docs/user-stories.md Visitor Experience acceptance criteria (line 10 on main): Still says "Page loads fast (static assets, CDN-ready)." Rails 8 serves dynamic pages through Puma, not static assets through a CDN. Minor inconsistency.

  4. .gitignore is minimal: Contains only .claude-no-enforce. Future Rails development will need a much larger .gitignore (log/, tmp/, db/*.sqlite3, etc.), but that is outside this PR's scope.

All nits are consistency issues from incomplete migration of Vite-era language. They are non-blocking because issue #8 scopes the fix to the tech stack, deployment pipeline, and request flow sections specifically -- the PR delivers on that scope.

SOP COMPLIANCE

  • Branch named after issue (8-fix-rails-8-docs references #8)
  • PR body follows template (Summary, Changes, Test Plan, Review Checklist, Related Notes)
  • Closes #8 present in Related Notes
  • No secrets committed
  • No unnecessary file changes (5 files, all on-topic)
  • Commit messages are descriptive (PR title: fix: update docs from Vite to Rails 8 stack)
  • Docs-only change -- no test coverage required

PROCESS OBSERVATIONS

  • Low risk change: documentation only, no deployment impact, no code paths affected.
  • The nits above suggest a follow-up issue to complete the Vite-to-Rails terminology migration in sections not covered by #8 (Adding a Vibe, Page Anatomy, Visitor Experience acceptance criteria). This would prevent confusion when actual Rails scaffolding begins.

VERDICT: APPROVED

## PR #9 Review ### DOMAIN REVIEW **Tech stack identified:** Documentation only (Markdown, Mermaid diagrams). No application code changed. The PR replaces Vite + vanilla HTML/CSS/JS + nginx references with Rails 8 + Hotwire + Importmap Rails + Propshaft + Puma across three documentation files, deletes the `.claude-no-enforce` sentinel, and adds a `.gitignore`. All changes are consistent with the stated goal. **Verified:** - `CLAUDE.md` is a symlink to `README.md` -- updates propagate automatically as the PR body claims. - No application code (Gemfile, controllers, etc.) exists in the repo yet -- this is purely a docs-ahead-of-code update, which is appropriate for the project phase. - Tech stack table in `docs/architecture.md` correctly replaces 3 Vite-era rows (Build/Markup/Server) with 4 Rails-era rows (Framework/Frontend/JS Imports/Assets/Server). Row count change is intentional and correct. - Deployment pipeline and request flow Mermaid diagrams updated consistently (Build Vite -> rails asset:precompile, Docker nginx -> Docker Puma, nginx Pod -> Puma Pod). ### BLOCKERS None. This is a docs-only change. No code paths, no user input handling, no secrets, no test coverage requirements apply. ### NITS 1. **README.md "Adding a Vibe" section not updated** (line 25 on main): Still reads `Create a new directory under src/vibes/ with an index.html`. Under Rails 8, vibes would use Rails conventions (routes, controllers, views), not raw directories with `index.html` files. This section is now inconsistent with the updated Stack and Quick Start sections directly above it. 2. **docs/architecture.md "Page Anatomy" section not updated** (lines 64-66 on main): Still says "Its own `index.html`, styles, and scripts" and "Can import from shared utilities." Under Rails 8, pages would be views rendered by controllers, not standalone HTML files. Inconsistent with the updated tech stack table. 3. **docs/user-stories.md Visitor Experience acceptance criteria** (line 10 on main): Still says "Page loads fast (static assets, CDN-ready)." Rails 8 serves dynamic pages through Puma, not static assets through a CDN. Minor inconsistency. 4. **.gitignore is minimal**: Contains only `.claude-no-enforce`. Future Rails development will need a much larger `.gitignore` (log/, tmp/, db/*.sqlite3, etc.), but that is outside this PR's scope. All nits are consistency issues from incomplete migration of Vite-era language. They are non-blocking because issue #8 scopes the fix to the tech stack, deployment pipeline, and request flow sections specifically -- the PR delivers on that scope. ### SOP COMPLIANCE - [x] Branch named after issue (`8-fix-rails-8-docs` references #8) - [x] PR body follows template (Summary, Changes, Test Plan, Review Checklist, Related Notes) - [x] `Closes #8` present in Related Notes - [x] No secrets committed - [x] No unnecessary file changes (5 files, all on-topic) - [x] Commit messages are descriptive (PR title: `fix: update docs from Vite to Rails 8 stack`) - [x] Docs-only change -- no test coverage required ### PROCESS OBSERVATIONS - Low risk change: documentation only, no deployment impact, no code paths affected. - The nits above suggest a follow-up issue to complete the Vite-to-Rails terminology migration in sections not covered by #8 (Adding a Vibe, Page Anatomy, Visitor Experience acceptance criteria). This would prevent confusion when actual Rails scaffolding begins. ### VERDICT: APPROVED
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Author
Owner

PR #9 Review

DOMAIN REVIEW

Tech stack identified: Documentation only (Markdown, Mermaid diagrams). No application code exists in this repo -- no Gemfile, no package.json, no Dockerfile, no CI config. The entire repo consists of README.md, CLAUDE.md (symlink to README.md), docs/architecture.md, docs/user-stories.md, and .claude-no-enforce.

This PR updates documentation references from the old Vite + vanilla HTML/CSS/JS + nginx stack to Rails 8 + Hotwire + Importmap Rails + Propshaft + Puma, and performs housekeeping on .claude-no-enforce.

Diff analysis (5 files, +18/-15):

  1. .claude-no-enforce -- Deleted. Correct: this was an empty sentinel file that should be cleaned up.
  2. .gitignore -- Created with a single entry: .claude-no-enforce. This ensures the file stays gone.
  3. README.md -- Stack, Quick Start, and Adding a Vibe sections updated from Vite to Rails 8 terminology. Since CLAUDE.md is a symlink to README.md, it will reflect these changes automatically.
  4. docs/architecture.md -- Tech stack table correctly expanded from 4 rows (Vite/Audio/Markup/Server) to 6 rows (Framework/Frontend/JS Imports/Assets/Audio/Server). Deployment pipeline and request flow Mermaid diagrams updated. Page anatomy description updated from "index.html, styles, scripts" to "controller action, view template, partials, Stimulus controllers".
  5. docs/user-stories.md -- Two acceptance criteria updated: "static assets, CDN-ready" to "server-rendered, asset-pipeline optimized" and "vite dev" to "rails server".

All changes are internally consistent -- every Vite/nginx reference has been replaced with the Rails 8 equivalent. No stale references remain in the diff.

BLOCKERS

None.

This is a docs-only change. No application code, no secrets, no security surface. The documentation correctly reflects the intended Rails 8 stack direction for this project.

NITS

  1. .gitignore scope -- The .gitignore contains only .claude-no-enforce. If the project is moving to Rails 8, it will eventually need a proper .gitignore (Rails defaults, /tmp, /log, .env, etc.). Not blocking since no application code exists yet -- this can be added when the scaffold lands.

  2. "No SPA routing, no shared state" in architecture.md overview (line 5, unchanged) -- This line was not touched by the PR and is technically still accurate for the current docs-only state, but once Rails 8 + Hotwire lands, it may need revisiting since Turbo does involve client-side navigation. Not blocking and outside scope of this PR.

  3. Adding a Vibe section in README.md -- The new text reads "Add a route, controller, and view under app/views/vibes/." This is reasonable guidance but slightly imprecise -- the route goes in config/routes.rb, the controller in app/controllers/, and the view in app/views/vibes/. Minor wording nit since this is a quick-start summary, not a tutorial.

SOP COMPLIANCE

  • Branch named after issue (8-fix-rails-8-docs references issue #8)
  • PR body follows template (Summary, Changes, Test Plan, Review Checklist, Related Notes all present)
  • Closes #8 present in Related Notes section
  • No secrets committed
  • No unnecessary file changes -- all 5 files are in scope for the stated objective
  • Commit messages are descriptive (PR title: "fix: update docs from Vite to Rails 8 stack")
  • Related Notes does not reference a plan slug (no plan note exists for this issue -- acceptable for a small docs-only fix)
  • Test plan is appropriate for a docs-only change (manual review items, no automated tests expected)

PROCESS OBSERVATIONS

  • Low-risk change: documentation-only, no deployment impact, no code paths affected.
  • The .claude-no-enforce cleanup is good housekeeping -- removing the sentinel and gitignoring it prevents re-creation.
  • Change failure risk: zero. These are markdown files with no runtime impact.

VERDICT: APPROVED

## PR #9 Review ### DOMAIN REVIEW **Tech stack identified:** Documentation only (Markdown, Mermaid diagrams). No application code exists in this repo -- no Gemfile, no package.json, no Dockerfile, no CI config. The entire repo consists of README.md, CLAUDE.md (symlink to README.md), docs/architecture.md, docs/user-stories.md, and .claude-no-enforce. This PR updates documentation references from the old Vite + vanilla HTML/CSS/JS + nginx stack to Rails 8 + Hotwire + Importmap Rails + Propshaft + Puma, and performs housekeeping on .claude-no-enforce. **Diff analysis (5 files, +18/-15):** 1. **.claude-no-enforce** -- Deleted. Correct: this was an empty sentinel file that should be cleaned up. 2. **.gitignore** -- Created with a single entry: `.claude-no-enforce`. This ensures the file stays gone. 3. **README.md** -- Stack, Quick Start, and Adding a Vibe sections updated from Vite to Rails 8 terminology. Since CLAUDE.md is a symlink to README.md, it will reflect these changes automatically. 4. **docs/architecture.md** -- Tech stack table correctly expanded from 4 rows (Vite/Audio/Markup/Server) to 6 rows (Framework/Frontend/JS Imports/Assets/Audio/Server). Deployment pipeline and request flow Mermaid diagrams updated. Page anatomy description updated from "index.html, styles, scripts" to "controller action, view template, partials, Stimulus controllers". 5. **docs/user-stories.md** -- Two acceptance criteria updated: "static assets, CDN-ready" to "server-rendered, asset-pipeline optimized" and "vite dev" to "rails server". All changes are internally consistent -- every Vite/nginx reference has been replaced with the Rails 8 equivalent. No stale references remain in the diff. ### BLOCKERS None. This is a docs-only change. No application code, no secrets, no security surface. The documentation correctly reflects the intended Rails 8 stack direction for this project. ### NITS 1. **.gitignore scope** -- The .gitignore contains only `.claude-no-enforce`. If the project is moving to Rails 8, it will eventually need a proper .gitignore (Rails defaults, /tmp, /log, .env, etc.). Not blocking since no application code exists yet -- this can be added when the scaffold lands. 2. **"No SPA routing, no shared state" in architecture.md overview** (line 5, unchanged) -- This line was not touched by the PR and is technically still accurate for the current docs-only state, but once Rails 8 + Hotwire lands, it may need revisiting since Turbo does involve client-side navigation. Not blocking and outside scope of this PR. 3. **Adding a Vibe section in README.md** -- The new text reads "Add a route, controller, and view under `app/views/vibes/`." This is reasonable guidance but slightly imprecise -- the route goes in `config/routes.rb`, the controller in `app/controllers/`, and the view in `app/views/vibes/`. Minor wording nit since this is a quick-start summary, not a tutorial. ### SOP COMPLIANCE - [x] Branch named after issue (`8-fix-rails-8-docs` references issue #8) - [x] PR body follows template (Summary, Changes, Test Plan, Review Checklist, Related Notes all present) - [x] `Closes #8` present in Related Notes section - [x] No secrets committed - [x] No unnecessary file changes -- all 5 files are in scope for the stated objective - [x] Commit messages are descriptive (PR title: "fix: update docs from Vite to Rails 8 stack") - [ ] Related Notes does not reference a plan slug (no plan note exists for this issue -- acceptable for a small docs-only fix) - [x] Test plan is appropriate for a docs-only change (manual review items, no automated tests expected) ### PROCESS OBSERVATIONS - Low-risk change: documentation-only, no deployment impact, no code paths affected. - The .claude-no-enforce cleanup is good housekeeping -- removing the sentinel and gitignoring it prevents re-creation. - Change failure risk: zero. These are markdown files with no runtime impact. ### VERDICT: APPROVED
ldraney deleted branch 8-fix-rails-8-docs 2026-06-19 04:16:34 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
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
ldraney/my-vibes-world!9
No description provided.