Skip to content

Conversation

@rubenpenap
Copy link
Contributor

@rubenpenap rubenpenap commented Jan 17, 2026

Summary

This PR adds 11 comprehensive skill guides (SKILL.md files) to .cursor/skills/ that document Epic Stack best practices and patterns. Each guide includes when to use it, patterns, conventions, common mistakes, and references.

Guides added:

  • epic-auth: Authentication, sessions, OAuth, 2FA, and passkeys
  • epic-caching: Caching with cachified, SQLite cache, and LRU cache
  • epic-database: Prisma, SQLite, and LiteFS
  • epic-deployment: Deployment with Fly.io, multi-region setup, and CI/CD
  • epic-forms: Forms with Conform and validation with Zod
  • epic-permissions: RBAC system and permissions
  • epic-react-patterns: React patterns, performance optimization, and code quality
  • epic-routing: Routing with React Router and react-router-auto-routes
  • epic-security: Security practices including CSP, rate limiting, and session security
  • epic-testing: Testing with Vitest and Playwright
  • epic-ui-guidelines: UI/UX guidelines, accessibility, and component usage

These guides serve as comprehensive references to help developers understand and implement Epic Stack best practices and conventions.

Test Plan

No tests required because:

  • Only documentation files are added (docs/skills/*/SKILL.md)
  • No functional code changes
  • No changes to business logic
  • Does not affect application execution

Suggested verification steps:

  1. Verify all 11 SKILL.md files exist in docs/skills/
  2. Check markdown formatting is correct
  3. Review that references to codebase files are accurate
  4. Confirm Cursor can properly read these skills

Checklist

  • Tests updated (N/A - documentation only)
  • Docs updated (The added files are the new documentation)

Screenshots

N/A - Only documentation files were added.

- Introduced new SKILL.md files covering authentication, caching, database management, deployment, forms, permissions, React best practices, routing, security, testing, and UI guidelines.
- Each guide includes usage scenarios, patterns, conventions, common mistakes, and references to enhance developer understanding and implementation of best practices in the Epic Stack.
@cr101
Copy link

cr101 commented Jan 19, 2026

Thank you for putting this together.

Do you think it would be better to place the skill folders inside a .github/skills/ directory at the root of the repository instead to ensure that AI agents (Cursor , Claude Code, VS Code Copilot, and other emerging agentic frameworks) can find and use the custom instructions?

@rubenpenap
Copy link
Contributor Author

Hey Cris! Thanks for the suggestion, that makes a lot of sense

I initially placed the skills under .cursor mainly because the folder already existed and felt like a natural starting point. That said, I totally agree that .github/skills/ at the repo root is probably a better, more discoverable convention for agents across Cursor, Claude Code, Copilot, and others.

Happy to move them there if you think that’s the right call, no problem at all on my side. Let me know what you prefer and I’ll adjust it.

@cr101
Copy link

cr101 commented Jan 19, 2026

please place the skills in .github/skills/ Thank you

@kentcdodds
Copy link
Member

Is there no standard place to put these? Will putting them in .github/skills/ work for cursor, vscode, claude code, etc?

Co-authored-by: Sergio Xalambrí <hello@sergiodxa.com>
@rubenpenap
Copy link
Contributor Author

There’s no official standard yet for where AI agent rules/skills should live, but the emerging convention is to keep shared, tool-agnostic instructions in .github/ (e.g. .github/skills/ or .github/ai/). This makes them discoverable by multiple agents and avoids editor/vendor lock-in.

@kentcdodds Kent, could you confirm whether you’d prefer this to live under .github/ (e.g. .github/skills/), or if you’d suggest a better location? I’m happy to adjust it to match whatever you think works best.

@sergiodxa
Copy link
Contributor

.github/skills doesn't seem tool-agnostic, that looks like what GH Copilot uses.

From what I understand, any SKILL.md in any part of the repo should work, right? You could have docs/skills/ folder even

@kentcdodds
Copy link
Member

I like docs/skills personally

- Relocate all skill guides from .cursor/skills/ to docs/skills/
- Rename epic-react-best-practices to epic-react-patterns
@rubenpenap
Copy link
Contributor Author

The change is ready 👍

@kentcdodds
Copy link
Member

Right now we delete the docs directory when initializing the project. I think we should probably not do that anymore in general, and we'll definitely not want to do that for these skills. Could you remove that bit in the init script?

- Eliminated the removal of the 'docs' directory from the cleanup process in the main function.
@rubenpenap
Copy link
Contributor Author

The change is ready 🔥

Copy link
Member

@kentcdodds kentcdodds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Let's see how it goes 🤞

@kentcdodds kentcdodds merged commit 2abbd5b into epicweb-dev:main Jan 20, 2026
5 checks passed
@kentcdodds
Copy link
Member

Thanks a ton for putting these together!

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.

4 participants