Merge pull request #4 from macalinao/igm/docs-v2

Add basic documentation site

Author: macalinao

.changeset/deep-carrots-wink.md

@@ -0,0 +1,8 @@
+---
+"@macalinao/clients-token-metadata": patch
+"@macalinao/clients-quarry": patch
+"@macalinao/coda": patch
+"@macalinao/coda-docs": patch
+---
+
+Add documentation site

.changeset/wicked-apples-stare.md

@@ -0,0 +1,8 @@
+---
+"@macalinao/clients-token-metadata": patch
+"@macalinao/clients-quarry": patch
+"@macalinao/coda": patch
+"@macalinao/coda-docs": patch
+---
+
+Update all dependencies

.gitignore

@@ -7,6 +7,8 @@ node_modules/
 dist/
 build/
 .turbo
+docs/.next/
+# docs/content/docs/api/clients/
 
 # TypeScript
 *.tsbuildinfo

CLAUDE.md

@@ -31,8 +31,8 @@ bun run build:watch:packages # Watch mode for packages only
 
 # Code Generation
 bun run codegen             # Run code generation for all clients
-bunx coda generate          # Generate client with Coda CLI
-bunx coda init             # Initialize coda.config.mjs
+coda generate               # Generate client with Coda CLI
+coda init                  # Initialize coda.config.mjs
 
 # Code Quality
 bun run lint                 # Run biome check + eslint
@@ -69,10 +69,11 @@ coda/
 ## Core Packages
 
 ### 1. **@macalinao/coda** - CLI for client generation
-   - Zero-config by default (looks for `./target/idl/program.json`)
+   - Zero-config by default (looks for `./idls/*.json`)
    - Configurable via `coda.config.mjs`
    - Generates TypeScript clients with full type safety
    - Built on Codama for extensibility
+   - Supports glob patterns for IDL discovery
 
 ### 2. **@macalinao/codama-instruction-accounts-dedupe-visitor**
    - Flattens nested account structures from Anchor IDL
@@ -88,7 +89,7 @@ coda/
 ### 4. **@macalinao/clients-token-metadata**
    - Pre-generated client for Metaplex Token Metadata program
    - Includes custom PDAs and type definitions
-   - Ready-to-use with `@solana/web3.js`
+   - Ready-to-use TypeScript client
 
 ## How Coda Works
 
@@ -100,12 +101,21 @@ coda/
 
 ## Configuration (coda.config.mjs)
 
+### Default Configuration
+Coda automatically discovers IDLs without any configuration:
+- Looks for `./idls/*.json` by default
+- Place your IDL files in the `idls/` directory
+- No config file needed for basic usage!
+
+### Single IDL Configuration
+For projects with a single program (like [token-metadata](https://github.com/macalinao/coda/tree/master/clients/token-metadata)):
+
 ```javascript
 import { defineConfig } from "@macalinao/coda";
 import { addPdasVisitor } from "codama";
 
 export default defineConfig({
-  // Optional: Custom paths
+  // Optional: Custom path for single IDL
   idlPath: "./idls/my_program.json",
   outputDir: "./src/generated",
 
@@ -118,6 +128,56 @@ export default defineConfig({
 });
 ```
 
+### Multiple IDL Configuration with Glob Pattern
+For projects with multiple programs (like [quarry](https://github.com/macalinao/coda/tree/master/clients/quarry)):
+
+```javascript
+import { defineConfig } from "@macalinao/coda";
+
+export default defineConfig({
+  // Use glob pattern to match all IDLs
+  idlPath: "./idls/*.json",
+  outputDir: "./src/generated",
+  
+  // Optional: Add PDAs and other visitors for each program
+  visitors: [
+    // Custom visitors for each program
+  ]
+});
+```
+
+### Multiple IDL Configuration with Array
+You can also explicitly list IDL files:
+
+```javascript
+import { defineConfig } from "@macalinao/coda";
+
+export default defineConfig({
+  // Array of specific IDL paths
+  idlPath: [
+    "./idls/program1.json",
+    "./idls/program2.json",
+    "./custom/path/program3.json",
+  ],
+  outputDir: "./src/generated",
+});
+```
+
+### Advanced Glob Patterns
+Use specific patterns to match only certain IDLs:
+
+```javascript
+import { defineConfig } from "@macalinao/coda";
+
+export default defineConfig({
+  // Match only IDLs starting with "quarry_"
+  idlPath: "./idls/quarry_*.json",
+  // Or combine multiple patterns
+  // idlPath: ["./idls/quarry_*.json", "./extra/*.json"],
+  outputDir: "./src/generated",
+});
+```
+
 ## Code Style Guidelines
 
 ### TypeScript
@@ -207,9 +267,7 @@ Generated clients provide:
 Example usage:
 ```typescript
 import { createTransferInstruction } from "./generated";
-import { createSolanaRpc } from "@solana/web3.js";
 
-const rpc = createSolanaRpc("https://api.mainnet-beta.solana.com");
 const instruction = createTransferInstruction({
   source: sourceAddress,
   destination: destAddress,
@@ -218,6 +276,40 @@ const instruction = createTransferInstruction({
 });
 ```
 
+## Documentation Guidelines
+
+### Writing Good Documentation
+
+When writing documentation for Coda or generated clients:
+
+1. **Command Examples**: 
+   - Always show direct command usage: `coda generate`, not `bunx coda generate` or `npx coda`
+   - Assume users have installed the package globally or are using it directly
+   - Show the simplest path to success
+
+2. **Code Examples**:
+   - Provide complete, runnable examples
+   - Show imports clearly at the top
+   - Use TypeScript for all examples
+   - Include types where helpful for clarity
+
+3. **Structure**:
+   - Start with the most common use case
+   - Progress from simple to complex
+   - Link to relevant examples in the repository
+   - Use clear headings and subheadings
+
+4. **Best Practices**:
+   - Explain the "why" not just the "how"
+   - Include error messages users might see
+   - Provide solutions to common problems
+   - Keep examples concise but complete
+
+5. **Links and References**:
+   - Link to example repositories (e.g., token-metadata for single IDL, quarry for multiple IDLs)
+   - Reference the official Codama documentation where appropriate
+   - Include links to Anchor documentation for IDL-related topics
+
 ## Troubleshooting
 
 ### Common Issues

biome.json renamed to biome.jsonc

@@ -7,7 +7,14 @@
     "defaultBranch": "master"
   },
   "files": {
-    "ignoreUnknown": false
+    "ignoreUnknown": false,
+    "includes": [
+      "**",
+      "!docs/.next",
+      "!out",
+      "!**/bun.lock",
+      "!apps/example-dapp/src/routeTree.gen.ts"
+    ]
   },
   "formatter": {
     "enabled": true,
@@ -18,23 +25,19 @@
     "lineEnding": "lf",
     "lineWidth": 80,
     "attributePosition": "auto",
-    "bracketSpacing": true,
-    "includes": [
-      "**",
-      "!**/bun.lock",
-      "!apps/example-dapp/src/routeTree.gen.ts"
-    ]
+    "bracketSpacing": true
   },
   "linter": {
     "enabled": true,
-    "domains": {
-      "project": "recommended"
-    },
+    // "domains": {
+    //   "project": "recommended"
+    // },
     "rules": {
       "recommended": true,
-      "nursery": {
-        "noFloatingPromises": "error"
-      },
+      // this thing lags super hard
+      // "nursery": {
+      //   "noFloatingPromises": "error"
+      // },
       "complexity": {
         "useSimplifiedLogicExpression": "error"
       },
@@ -69,24 +72,14 @@
         "noUnusedVariables": "warn",
         "noUnusedImports": "error"
       }
-    },
-    "includes": [
-      "**",
-      "!**/bun.lock",
-      "!apps/example-dapp/src/routeTree.gen.ts"
-    ]
+    }
   },
   "assist": {
     "actions": {
       "source": {
         "organizeImports": "on"
       }
-    },
-    "includes": [
-      "**",
-      "!**/bun.lock",
-      "!apps/example-dapp/src/routeTree.gen.ts"
-    ]
+    }
   },
   "javascript": {
     "formatter": {