|
| 1 | +# AGENTS.md |
| 2 | + |
| 3 | +AI coding agent instructions for **docs** |
| 4 | + |
| 5 | +## Project Overview |
| 6 | + |
| 7 | +Official documentation for Nano Collective projects. Find guides, API references, and examples to help you build with our tools. |
| 8 | + |
| 9 | +**Project Type:** Next.js Web Application |
| 10 | +**Primary Language:** TypeScript (99% of codebase) |
| 11 | + |
| 12 | +## Architecture |
| 13 | + |
| 14 | +**Key Frameworks & Libraries:** |
| 15 | +- Next.js (16.1.3) - web |
| 16 | +- React (19.2.3) - web |
| 17 | + |
| 18 | +**Project Structure:** |
| 19 | +- `app/` - Application code |
| 20 | +- `components/` - React/UI components |
| 21 | +- `lib/` - Library code |
| 22 | +- `public/` - Public assets |
| 23 | +- `app/[project]/` - Project files |
| 24 | +- `components/home/` - Project files |
| 25 | +- `components/ui/` - Project files |
| 26 | +- `app/[project]/docs/` - Documentation |
| 27 | +- `app/[project]/docs/[version]/` - Project files |
| 28 | +- `app/[project]/docs/[version]/[[...slug]]/` - Project files |
| 29 | + |
| 30 | +## Key Files |
| 31 | + |
| 32 | +**Configuration:** |
| 33 | +- `package.json` - Node.js dependencies and scripts |
| 34 | +- `pnpm-lock.yaml` - Configuration file |
| 35 | + |
| 36 | +**Documentation:** |
| 37 | +- `LICENSE.md` |
| 38 | +- `README.md` |
| 39 | +- `app/[project]/docs/[version]/[[...slug]]/not-found.tsx` |
| 40 | + |
| 41 | +## Development Commands |
| 42 | + |
| 43 | +**Build:** |
| 44 | +```bash |
| 45 | +npm run build |
| 46 | +``` |
| 47 | + |
| 48 | +**Development:** |
| 49 | +```bash |
| 50 | +npm run dev |
| 51 | +``` |
| 52 | + |
| 53 | +**Start:** |
| 54 | +```bash |
| 55 | +npm run start |
| 56 | +``` |
| 57 | + |
| 58 | +**Lint:** |
| 59 | +```bash |
| 60 | +npm run lint |
| 61 | +``` |
| 62 | + |
| 63 | +## Code Style Guidelines |
| 64 | + |
| 65 | +- Use camelCase for variables and functions |
| 66 | +- Use PascalCase for classes and components |
| 67 | +- Prefer const/let over var |
| 68 | +- Use async/await over callbacks when possible |
| 69 | +- Use functional components with hooks |
| 70 | +- Follow React naming conventions for components |
| 71 | + |
| 72 | +## Testing |
| 73 | + |
| 74 | +**Test Files:** |
| 75 | +- `components/ui/aspect-ratio.tsx` |
| 76 | + |
| 77 | +## AI Coding Assistance Notes |
| 78 | + |
| 79 | +**Important Considerations:** |
| 80 | +- Check package.json for available scripts before running commands |
| 81 | +- Be aware of Node.js version requirements |
| 82 | +- Consider impact on bundle size when adding dependencies |
| 83 | +- Be aware of SSR/SSG implications when making changes |
| 84 | +- Check routing structure before adding new pages |
| 85 | +- Follow React hooks best practices |
| 86 | +- Consider component reusability when creating new components |
| 87 | +- Project has 107 files across 15 directories |
| 88 | +- Check build configuration files before making structural changes |
| 89 | + |
| 90 | +--- |
| 91 | + |
| 92 | +*This AGENTS.md file was generated by Nanocoder. Update it as your project evolves.* |
0 commit comments