Skip to content

chore: refresh README, reference docs/, add pnpm test CI - #29

Merged
TusharW4ni merged 2 commits into
mainfrom
chore/readme-docs-and-test-ci
Aug 22, 2026
Merged

chore: refresh README, reference docs/, add pnpm test CI#29
TusharW4ni merged 2 commits into
mainfrom
chore/readme-docs-and-test-ci

Conversation

@TusharW4ni

Copy link
Copy Markdown
Contributor

What

Three related cleanups requested after the recent merges:

1. README fixes

  • Nuxt UI v3 → v4 (the label and the docs URL were stale; the dep is @nuxt/ui@^4.11).
  • Removed the broken docs/template_usage.md link (that file doesn't exist) and pointed it at the new Documentation section.
  • Corrected the AWS-region reference — it now lives in .github/workflows/deploy.yml, not main.yml.
  • Noted that CI runs pnpm test in the Testing section.

2. Reference the docs/ directory

Added a Documentation section linking every guide in docs/:
testing.md, better_auth.md, file_upload_and_serve.md, mcp.md — plus a docs/ entry in Project Structure.

3. pnpm test in CI

New .github/workflows/test.yml — runs pnpm install --frozen-lockfile + pnpm test on every pull request and on pushes to main/stage. Deploys stay in deploy.yml; this is the correctness gate that was missing (flagged in the #21/#25 reviews).

Verification

  • prettier --check README.md clean.
  • pnpm test passes locally (2 tests) on current main.
  • The workflow validates itself: this PR triggers test.yml, so the CI run on this PR is the proof it parses and passes. To make it a hard merge gate, enable branch protection requiring the test check.

🤖 Generated with Claude Code

TusharW4ni and others added 2 commits August 22, 2026 18:25
- Fix stale 'Nuxt UI v3' -> v4 label and docs URL
- Replace the broken docs/template_usage.md link and add a Documentation section referencing all docs/ guides
- Correct the AWS-region file reference (now in deploy.yml)
- Add .github/workflows/test.yml: runs pnpm test on every PR and on pushes to main/stage

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…cation)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@TusharW4ni
TusharW4ni merged commit b0d1114 into main Aug 22, 2026
1 check passed
@TusharW4ni
TusharW4ni deleted the chore/readme-docs-and-test-ci branch August 22, 2026 23:29
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