Skip to content

Docs: fix Live Demo link, publish roadmap, welcome contributors#5

Open
evangauer wants to merge 4 commits into
mainfrom
feat/readme-growth
Open

Docs: fix Live Demo link, publish roadmap, welcome contributors#5
evangauer wants to merge 4 commits into
mainfrom
feat/readme-growth

Conversation

@evangauer
Copy link
Copy Markdown
Owner

@evangauer evangauer commented Jun 3, 2026

Why

The README and roadmap are how clinics, vets, and contributors evaluate an open-source project before they trust it. Two things were getting in the way: the Live Demo link pointed at openvpm.com/demo, which 404s (so anyone trying to see the product hit a dead end), and the roadmap didn't reflect what actually shipped.

What

  • Fix the Live Demo linkdemo.openvpm.com/login (one-click logins, no signup) so clinics can actually try it.
  • Add ROADMAP.md (Now / Next / Later) plus how to influence it, and refresh the README roadmap to match what's built — so the community can see where the project is going and where to help.
  • Welcome contributors — PRs-Welcome and Discussions badges, and a "Good first issues" section in CONTRIBUTING.md.
  • /demo redirect on the site so older links land on the demo instead of 404ing.

Notes

Docs + one tiny redirect route; no app logic changes. Stacked on fix/lockfile-tiptap (PR #3) for green CI; rebases cleanly once #3 merges.

🤖 Generated with Claude Code

evangauer and others added 3 commits June 2, 2026 14:16
Two pre-existing breakages on main (from the TipTap PR) that fail CI and Vercel:

1. pnpm-lock.yaml was missing the @tiptap/* dependencies declared in
   apps/web/package.json, so 'pnpm install --frozen-lockfile' (CI + Vercel)
   failed with ERR_PNPM_OUTDATED_LOCKFILE. Regenerated the lockfile.
2. records/new-soap imported '@/components/SoapNoteEditor', but the component
   lived in app/components/ (the @/ alias resolves to the app root, not app/).
   Moved SoapNoteEditor + SoapNoteDisplay into components/ to match the
   repo convention (components/{ui,layout,common}) so the import resolves.

Verified: pnpm install --frozen-lockfile, type-check, test (119), and build
all pass for both apps.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
A visitor who came straight to demo.openvpm.com hit a 307 to the marketing
site (unauthenticated root -> NEXT_PUBLIC_WWW_URL), which dead-ended anyone
trying to actually try the demo. Now unauthenticated root redirects to /login,
which offers one-click demo access. Removes the funnel leak on the demo
subdomain.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
The README's primary 'Live Demo' link pointed at openvpm.com/demo, which 404s —
a direct conversion leak for repo visitors. Fixes:
- Point Live Demo at the working demo.openvpm.com/login (one-click logins).
- Add a top-of-README demo + star call-to-action, plus PRs-Welcome and
  Discussions badges.
- Add a /demo redirect on the marketing site so the old URL (and any links in
  past posts) lands on the demo instead of 404ing.
- Add ROADMAP.md (Now/Next/Later + how to influence it) and refresh the README
  roadmap to reflect what shipped (API, Agent, dosing, vitals, treatment plans,
  wellness, online booking, CSV import).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
openvpm Ready Ready Preview, Comment Jun 3, 2026 12:32am

Request Review

Gives new contributors concrete, scoped starting points (dosing formulary,
drag-to-reschedule, waitlist, CSV import UI, booking widget) and signals an
active, welcoming project — turning repo visitors into contributors.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@evangauer evangauer changed the title Grow stars: fix broken demo link, sharpen README, add ROADMAP Docs: fix Live Demo link, publish roadmap, welcome contributors Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant