Align docs with Harbor-pull dev workflow #1

New issue

Closed

opened 2026-05-24 16:54:23 +00:00 by ldraney · 0 comments

ldraney commented

2026-05-24 16:54:23 +00:00

Owner

Type

Chore

Lineage

Standalone — aligning rails-base docs with how base-images actually works.

Repo

ldraney/rails-base

User Story

As a developer starting a new Rails app, I want the guide to match reality so I can follow it end-to-end without hitting dead references.

Context

starting-a-new-project.md was written assuming a Dockerfile.dev per project and a templates/ directory. The actual architecture pulls ruby-rails-build from Harbor via docker-compose — no per-project Dockerfile needed for dev. The guide and Mermaid diagram reference artifacts that don't exist.

File Targets

docs/starting-a-new-project.md — remove Dockerfile.dev refs, fix templates/ path, update diagram and steps
README.md — remove dead links to unwritten docs (platform-stack.md, css-conventions.md)

Acceptance Criteria

Guide matches the Harbor-pull workflow (copy docker-compose.yml, no Dockerfile.dev)
No references to nonexistent templates/ directory
Mermaid diagram reflects actual flow
README only links to docs that exist

Test Expectations

Manual review — docs only.

Constraints

None.

Checklist

Fix starting-a-new-project.md
Fix README.md

ldraney/base-images#5

### Type Chore ### Lineage Standalone — aligning rails-base docs with how base-images actually works. ### Repo ldraney/rails-base ### User Story As a developer starting a new Rails app, I want the guide to match reality so I can follow it end-to-end without hitting dead references. ### Context `starting-a-new-project.md` was written assuming a `Dockerfile.dev` per project and a `templates/` directory. The actual architecture pulls `ruby-rails-build` from Harbor via docker-compose — no per-project Dockerfile needed for dev. The guide and Mermaid diagram reference artifacts that don't exist. ### File Targets - `docs/starting-a-new-project.md` — remove Dockerfile.dev refs, fix templates/ path, update diagram and steps - `README.md` — remove dead links to unwritten docs (platform-stack.md, css-conventions.md) ### Acceptance Criteria - Guide matches the Harbor-pull workflow (copy docker-compose.yml, no Dockerfile.dev) - No references to nonexistent `templates/` directory - Mermaid diagram reflects actual flow - README only links to docs that exist ### Test Expectations Manual review — docs only. ### Constraints None. ### Checklist - [ ] Fix starting-a-new-project.md - [ ] Fix README.md ### Related ldraney/base-images#5