chore(FRG-278): polish repo for public sharing

[chillkimtest-oss]

What

Polishes the OhMyDoc GitHub repo so people landing on it for the first time can understand what it does and get running in under 2 minutes.

Changes

README overhaul

• Product description with live link to ohmydoc.vercel.app
• Screenshot showing dual-panel resume formatting
• Quick Start guide (clone → env → install → dev)
• API key reference table
• Architecture overview and template system docs

Cleanup

• Removed .taskmaster/ (internal task tracking)
• Removed docs/my-command-history.md and docs/agent-computer-installation.md (dev artifacts)
• Removed docs/test-reports/ (internal QA reports)
• Removed dist symlink (build artifact)
• Trimmed CLAUDE.md from 400+ lines to ~80 lines of essential contributor guidance

Added

• MIT LICENSE
• Screenshot in public/screenshot.png
• Updated package.json name from nuxt-app to ohmydoc

Closes FRG-278

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
ohmydoc-using-claude-code-agent	Ready	Preview, Comment	Mar 23, 2026 8:24pm

[chillkimtest-oss]

Review Summary

Good foundation — cleanup of internal artifacts is substantial and the README is a big improvement over the Nuxt starter default. A few issues need attention before merging.

---

Blocking Issues

1. README.md — Wrong framework version

The README says "Nuxt 3" in the Tech Stack section, but package.json has nuxt: ^4.1.3. These are meaningfully different versions.

- **[Nuxt 3](https://nuxt.com)** (Vue 3) — app framework

→ Change to Nuxt 4 (or just Nuxt with a link to the docs).

---

2. README.md — Unimplemented document type listed

"Supported Document Types" includes:

- **Resignation Letter** — formal resignation template

The actual templates are cover letter variants (Modern, Classic, Minimal). There is no resignation letter template in /templates/. This will confuse users who try it and get unexpected results. Remove or mark as "coming soon."

---

3. .vercel/project.json — Internal deployment identifier committed

The file contains:

{"projectId":"prj_5M8C6OEOi1FuZvQsJeEkhuS3fGf3","orgId":"team_dLj1EOpBJy7YEvKl4X0AQwmP","projectName":"ohmydoc"}

This exposes your Vercel project ID and org ID publicly. While not an API secret, it identifies your Vercel org. Add .vercel to .gitignore — this file isn't relevant to contributors running the project locally.

---

4. CLAUDE.md — Critical CSS import gotcha removed

The original CLAUDE.md had a detailed warning about CSS imports in templates:

❌ WRONG: <style scoped>@import './styles.css';</style>
❌ WRONG: <style scoped src="./styles.css"></style>
✅ CORRECT: import './styles.css' in <script> + empty <style scoped>

This was hard-won guidance (the reason being Vercel production failures). The new CLAUDE.md's "Adding New Templates" steps say only "Use scoped CSS only" without this critical detail. A contributor following the new docs will hit the same production bug. Restore the CSS import note in the template instructions.

---

Non-Blocking Suggestions

5. .playwright-mcp/ — Test artifact directory not cleaned up

.playwright-mcp/ contains test screenshots (test-report-debug-parser-page.png, test-report-home-page.png). These are internal QA artifacts similar to docs/test-reports/ which was removed. Add to .gitignore alongside the existing Playwright exclusions.

6. .mcp.json and .claude/ — Internal dev workflow files

.mcp.json configures task-master-ai (now removed from .taskmaster/), and .claude/ contains internal agent commands and TM guides. They're harmless but add noise for external contributors. Consider whether to keep, document, or gitignore them.

7. README.md — Monaco Editor missing from Tech Stack

If Monaco editor (nuxt-monaco-editor) is still used, it should appear in the Tech Stack. The dual-panel editor is a core part of the product and omitting it from the stack description is a notable gap for contributors.

8. LICENSE — Informal copyright name

Copyright (c) 2026 Kim

Low priority, but for a public OSS license most projects use a full name or GitHub org name rather than a first name only. Worth considering before the public launch.

---

What Looks Good

• Cleanup of .taskmaster/, docs/agent-computer-installation.md, docs/my-command-history.md, docs/test-reports/ is clean and complete
• README hook and live link are effective for first-time visitors
• Quick Start steps are accurate: .env.example exists, commands match package.json, flow is logical
• API keys table matches .env.example contents
• package.json name updated correctly from nuxt-app → ohmydoc
• CLAUDE.md trim is appropriate — remaining content is what a contributor actually needs
• MIT LICENSE addition is correct