Create pal-enterprises-docs RoR repo #12
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Type
Feature
Lineage
Standalone — implements the
-docssurface perconvention-client-project-structure. This is the first deliverable for any client, and pal-enterprises dogfoods it.Repo
New repo:
ldraney/pal-enterprises-docsUser Story
As a client logged into pal-enterprises
I want to click my
-docslink and see rendered project documentation with diagramsSo that Lucas, AI, and I share a common understanding of user stories and system architecture before any code ships
Context
Per
convention-client-project-structure, docs are built FIRST. The-docssurface is a separate RoR repo (not a route in pal-enterprises). It renders markdown + mermaid diagrams behind Keycloak auth. Uses plain CSS via~/ror-css-guide(no Tailwind). Thedocs/directory in the pal-enterprises repo contains the content — this new repo renders it as a web app.For pal-enterprises specifically, this is the platform vision document — what pal-enterprises is, its architecture, the four-surface convention, and the client onboarding flow.
File Targets
New repo scaffold:
Gemfile— Rails 8.1, markdown rendering gem (redcarpet or commonmarker), no Tailwindapp/controllers/docs_controller.rb— renders markdown from content directoryapp/views/layouts/application.html.erb— plain CSS layout per ror-css-guideapp/assets/stylesheets/— CSS following ~/ror-css-guide conventions (design tokens, mobile-first)config/routes.rb—/renders index,/:slugrenders individual docsDockerfile— production build.woodpecker.yaml— CI pipelinek8s/dev.yaml— dev deployment with hostPath mountcontent/— markdown + mermaid source files (or symlink to pal-enterprises/docs/)Acceptance Criteria
ldraney/pal-enterprises-docspal-enterprises-docs.tail5b443a.ts.netTest Expectations
bin/rails testConstraints
Checklist
Related
convention-client-project-structure— docs-first build orderproject-pal-enterprises~/ror-css-guide— CSS conventions~/ror— Rails learning reference