Scaffold westside-docs Rails app #1

Open
opened 2026-05-10 02:06:37 +00:00 by forgejo_admin · 0 comments

Type

Feature

Lineage

Standalone — first issue for the westside-docs repo.

Repo

forgejo_admin/westside-docs

User Story

As Lucas
I want a westside-docs Rails app deployed with a public URL
So that Marcus and I have a shared contract documenting user stories and architecture before parallel work begins

Context

Every client project starts with a docs site — the contract between Lucas, AI, and the client. westside-docs is the first instance of this pattern. It's a standalone Rails 8.1 app (no Tailwind, plain CSS via ror-css-guide) with Mermaid.js for diagrams. Deployed via pal-e-deployments hostPath overlay for fast local iteration.

File Targets

Files the agent should modify or create:

  • app/controllers/docs_controller.rb -- index + wildcard show
  • app/views/docs/index.html.erb -- doc listing page
  • app/views/docs/architecture.html.erb -- system diagrams
  • app/views/docs/user-stories.html.erb -- user stories for Marcus
  • app/views/layouts/application.html.erb -- layout with Mermaid.js
  • app/views/layouts/_navbar.html.erb -- nav partial
  • app/assets/stylesheets/application.css -- design tokens from ror-css-guide
  • config/routes.rb -- docs routes

Acceptance Criteria

  • Rails 8.1 app boots with bin/rails server
  • / and /docs render the doc index
  • /docs/architecture renders with Mermaid diagrams
  • /docs/user-stories renders user stories
  • CSS uses ror-css-guide design tokens, no Tailwind
  • Deployed to cluster with public URL via Tailscale funnel

Test Expectations

  • Manual: visit each route in browser, confirm Mermaid renders
  • Health check: /up returns 200

Constraints

  • No Tailwind — plain CSS with Propshaft following ror-css-guide
  • Mermaid.js via CDN script tag
  • Deployment uses hostPath mount pattern from westside-ror overlay

Checklist

  • PR opened
  • Tests pass
  • No unrelated changes
  • westside -- project this affects
### Type Feature ### Lineage Standalone — first issue for the westside-docs repo. ### Repo `forgejo_admin/westside-docs` ### User Story As Lucas I want a westside-docs Rails app deployed with a public URL So that Marcus and I have a shared contract documenting user stories and architecture before parallel work begins ### Context Every client project starts with a docs site — the contract between Lucas, AI, and the client. westside-docs is the first instance of this pattern. It's a standalone Rails 8.1 app (no Tailwind, plain CSS via ror-css-guide) with Mermaid.js for diagrams. Deployed via pal-e-deployments hostPath overlay for fast local iteration. ### File Targets Files the agent should modify or create: - `app/controllers/docs_controller.rb` -- index + wildcard show - `app/views/docs/index.html.erb` -- doc listing page - `app/views/docs/architecture.html.erb` -- system diagrams - `app/views/docs/user-stories.html.erb` -- user stories for Marcus - `app/views/layouts/application.html.erb` -- layout with Mermaid.js - `app/views/layouts/_navbar.html.erb` -- nav partial - `app/assets/stylesheets/application.css` -- design tokens from ror-css-guide - `config/routes.rb` -- docs routes ### Acceptance Criteria - [ ] Rails 8.1 app boots with `bin/rails server` - [ ] `/` and `/docs` render the doc index - [ ] `/docs/architecture` renders with Mermaid diagrams - [ ] `/docs/user-stories` renders user stories - [ ] CSS uses ror-css-guide design tokens, no Tailwind - [ ] Deployed to cluster with public URL via Tailscale funnel ### Test Expectations - [ ] Manual: visit each route in browser, confirm Mermaid renders - [ ] Health check: `/up` returns 200 ### Constraints - No Tailwind — plain CSS with Propshaft following ror-css-guide - Mermaid.js via CDN script tag - Deployment uses hostPath mount pattern from westside-ror overlay ### Checklist - [ ] PR opened - [ ] Tests pass - [ ] No unrelated changes ### Related - `westside` -- project this affects
Sign in to join this conversation.
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/westside-docs#1
No description provided.