Skip to content

Commit 8a5a553

Browse files
committed
Merge branch 'main' of github.com:Nano-Collective/docs
2 parents 625262e + 1ed2000 commit 8a5a553

70 files changed

Lines changed: 6125 additions & 513 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,12 @@ on:
55
branches:
66
- main
77
workflow_dispatch:
8+
schedule:
9+
# Rebuild latest docs daily shortly after midnight UTC.
10+
- cron: "15 0 * * *"
811

912
concurrency:
10-
group: ${{ github.actor }}-push
13+
group: ${{ github.workflow }}-${{ github.ref }}
1114
cancel-in-progress: true
1215

1316
jobs:
@@ -24,9 +27,9 @@ jobs:
2427
lfs: true
2528

2629
- name: Set up PNPM
27-
uses: pnpm/action-setup@v2
30+
uses: pnpm/action-setup@v4
2831
with:
29-
version: 10.11.0
32+
version: null
3033

3134
- name: Use Node.js ${{ matrix.node-version }}
3235
uses: actions/setup-node@v4

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,7 @@ yarn-error.log*
4141
next-env.d.ts
4242

4343
# pagefind
44-
_pagefind/
44+
_pagefind/
45+
46+
# agents
47+
tasks.json

.nanocoder/commands/component.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
description: Create a new UI component
3+
aliases: [comp, ui]
4+
parameters: [name, type]
5+
---
6+
7+
Create a new {{type}} component named {{name}} that:
8+
9+
1. Follows project component patterns
10+
2. Includes proper TypeScript types
11+
3. Has responsive design considerations
12+
4. Includes basic styling structure
13+
5. Has proper prop validation
14+
15+
Make it reusable and well-documented.

.nanocoder/commands/refactor.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
description: Refactor JavaScript/TypeScript code
3+
aliases: [refactor-js, clean]
4+
parameters: [target]
5+
---
6+
7+
Refactor {{target}} to improve:
8+
9+
1. Code structure and organization
10+
2. Modern ES6+ syntax usage
11+
3. Performance optimizations
12+
4. Type safety (for TypeScript)
13+
5. Reusability and maintainability
14+
15+
Follow current project conventions and patterns.

.nanocoder/commands/review.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
description: Review code and suggest improvements
3+
aliases: [code-review, cr]
4+
parameters: [files]
5+
---
6+
7+
Review the code in {{files}} and provide detailed feedback on:
8+
9+
1. Code quality and best practices
10+
2. Potential bugs or issues
11+
3. Performance considerations
12+
4. Readability and maintainability
13+
5. Security concerns
14+
15+
Provide specific, actionable suggestions for improvement.

.nanocoder/commands/test.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
description: Generate comprehensive unit tests
3+
aliases: [unittest, test-gen]
4+
parameters: [filename]
5+
---
6+
7+
Generate comprehensive unit tests for {{filename}}.
8+
9+
Consider:
10+
1. Test all public functions and methods
11+
2. Include edge cases and error scenarios
12+
3. Use appropriate mocking where needed
13+
4. Follow existing test framework conventions
14+
5. Ensure good test coverage
15+
16+
If no filename provided, suggest which files need tests.

AGENTS.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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.*

LICENSE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# License
2+
3+
MIT License
4+
5+
Copyright (c) 2026 Nano Collective
6+
7+
Permission is hereby granted, free of charge, to any person obtaining a copy
8+
of this software and associated documentation files (the "Software"), to deal
9+
in the Software without restriction, including without limitation the rights
10+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11+
copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

0 commit comments

Comments
 (0)