mdview — Project Page

project-mdview Project Page

active project-page

Project

Vision

Browse your project docs from your phone. Register a repo's README, and mdview crawls its markdown links, validates them, and serves everything with mermaid diagram support. Post-commit hooks keep it current. Deployed on k3s behind Keycloak auth.

User Stories

Key	Story Note	Role	Success Metric
always-on	DONE	User	mdview accessible 24/7 via Tailscale Funnel (nginx proxy to archbox)
full-stack	TBD	Developer	Register READMEs via CLI, browse on phone via iOS app with Keycloak auth

Architecture

Current: nginx reverse proxy on cluster → archbox:3137 via Tailscale. mdview runs locally, cluster provides the Funnel URL. No database, no auth.

Target: Rails container on cluster with PostgreSQL (CNPG), Keycloak SSO, API token auth for CLI, Turbo Native iOS app.

Stack: Rails 8.1 + Puma + Hotwire
Ruby: 3.4.9
Auth: Keycloak SSO + API tokens for CLI
Database: PostgreSQL (CNPG) — API tokens, users, registered READMEs
Mobile: Turbo Native + Capacitor (iOS primary)
Ingress: Tailscale Funnel
Docs: docs/ui-ux.md in repo — screens, flows, design decisions

Board

Board: board-mdview

11 backlog tickets (one per remaining chapter) under story:full-stack. 6 done items from story:always-on.

Status

LIVE (proxy mode) — https://mdview.tail5b443a.ts.net/

Pod running, Funnel serving, CI pipeline operational. Current deployment is nginx proxy to archbox. Full-stack vision at chapter 7 (services wiring).

Scorecard: platform-playbook/scorecards/mdview/

Milestones

2026-05-24: Always-on deployment complete. Nginx proxy running, Funnel accessible.
2026-08-01: Full-stack vision scoped. Scorecard added. 11 backlog tickets created (Ch 6–17). README and docs/ui-ux.md updated with register/server/mobile design.

Repos

Repo	Platform	Role	Status
ldraney/mdview	Forgejo	Application source + CI	Active
ldraney/pal-e-deployments	Forgejo	Kustomize overlay (overlays/mdview/prod/)	Active
ldraney/pal-e-services	Forgejo	Terraform var.services entry	Active
ldraney/platform-playbook	Forgejo	Scorecard (scorecards/mdview/)	Active