Skip to content

AGENTS.md

Latest commit

 

History

History
92 lines (69 loc) · 2.14 KB

AGENTS.md

File metadata and controls

92 lines (69 loc) · 2.14 KB
Raw

AGENTS.md

AI coding agent instructions for docs

Project Overview

Official documentation for Nano Collective projects. Find guides, API references, and examples to help you build with our tools.

Project Type: Next.js Web Application Primary Language: TypeScript (99% of codebase)

Architecture

Key Frameworks & Libraries:

  • Next.js (16.1.3) - web
  • React (19.2.3) - web

Project Structure:

  • app/ - Application code
  • components/ - React/UI components
  • lib/ - Library code
  • public/ - Public assets
  • app/[project]/ - Project files
  • components/home/ - Project files
  • components/ui/ - Project files
  • app/[project]/docs/ - Documentation
  • app/[project]/docs/[version]/ - Project files
  • app/[project]/docs/[version]/[[...slug]]/ - Project files

Key Files

Configuration:

  • package.json - Node.js dependencies and scripts
  • pnpm-lock.yaml - Configuration file

Documentation:

  • LICENSE.md
  • README.md
  • app/[project]/docs/[version]/[[...slug]]/not-found.tsx

Development Commands

Build:

npm run build

Development:

npm run dev

Start:

npm run start

Lint:

npm run lint

Code Style Guidelines

  • Use camelCase for variables and functions
  • Use PascalCase for classes and components
  • Prefer const/let over var
  • Use async/await over callbacks when possible
  • Use functional components with hooks
  • Follow React naming conventions for components

Testing

Test Files:

  • components/ui/aspect-ratio.tsx

AI Coding Assistance Notes

Important Considerations:

  • Check package.json for available scripts before running commands
  • Be aware of Node.js version requirements
  • Consider impact on bundle size when adding dependencies
  • Be aware of SSR/SSG implications when making changes
  • Check routing structure before adding new pages
  • Follow React hooks best practices
  • Consider component reusability when creating new components
  • Project has 107 files across 15 directories
  • Check build configuration files before making structural changes

This AGENTS.md file was generated by Nanocoder. Update it as your project evolves.