Austin/patch documentation (#6)

* refactor: documentation

* feat: set UserAgent version to 0.0.0-dev when developing

Author: HungKNguyen

.github/pull_request_template.md

@@ -72,4 +72,4 @@ Relates to #
 
 ---
 
-**Reviewer Note**: Please ensure this PR follows our [Contributing Guidelines](../CONTRIBUTING.md) and meets all code review criteria.
+**Reviewer Note**: Please ensure this PR follows our [Contributing Guidelines](../docs/CONTRIBUTING.md) and meets all code review criteria.

.github/workflows/ci.yml

@@ -2,56 +2,56 @@ name: CI
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ main ]
   pull_request:
     branches: [ main ]
 
 jobs:
   lint-and-type-check:
     runs-on: ubuntu-latest
-    
+
     steps:
     - uses: actions/checkout@v4
-    
+
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
         cache: 'npm'
-    
+
     - name: Install dependencies
       run: npm ci
-    
+
     - name: Run linting
       run: npm run lint
-    
+
     - name: Run type checking
       run: npm run typecheck
 
   unit-tests:
     runs-on: ubuntu-latest
     needs: lint-and-type-check
-    
+
     strategy:
       matrix:
         node-version: [18.x, 20.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
-    
+
     steps:
     - uses: actions/checkout@v4
-    
+
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
-    
+
     - name: Install dependencies
       run: npm ci
-    
+
     - name: Run unit tests with coverage
       run: npm test -- --coverage --testPathPatterns='^((?!integration).)*$'
-    
+
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v3
       if: matrix.os == 'ubuntu-latest' && matrix.node-version == '20.x'
@@ -64,25 +64,25 @@ jobs:
   build:
     runs-on: ubuntu-latest
     needs: [lint-and-type-check, unit-tests]
-    
+
     steps:
     - uses: actions/checkout@v4
-    
+
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
         cache: 'npm'
-    
+
     - name: Install dependencies
       run: npm ci
-    
+
     - name: Build
       run: npm run build
-    
+
     - name: Verify build outputs
       run: |
         ls -la dist/
         test -f dist/index.js
         test -f dist/index.cjs
-        test -f dist/index.d.ts
+        test -f dist/index.d.ts

.github/workflows/security.yml

@@ -2,7 +2,7 @@ name: Security Checks
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ main ]
   pull_request:
     branches: [ main ]
   schedule:
@@ -14,19 +14,19 @@ jobs:
     permissions:
       contents: read
       security-events: write
-    
+
     steps:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
-    
+
     - name: Run Gitleaks
       uses: gitleaks/gitleaks-action@v2
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         GITLEAKS_LICENSE: ${{ secrets.GITLEAKS_LICENSE }}
       continue-on-error: true
-      
+
     - name: Check for hardcoded secrets
       run: |
         echo "🔍 Scanning for hardcoded secrets..."
@@ -53,25 +53,25 @@ jobs:
 
   dependency-check:
     runs-on: ubuntu-latest
-    
+
     steps:
     - uses: actions/checkout@v4
-    
+
     - name: Use Node.js
       uses: actions/setup-node@v4
       with:
         node-version: '20.x'
         cache: 'npm'
-    
+
     - name: Install dependencies
       run: npm ci
-    
+
     - name: Run npm audit
       run: |
         echo "🔍 Running npm audit..."
         npm audit --production --audit-level=moderate || echo "⚠️ Audit found issues but continuing..."
       continue-on-error: true
-    
+
     - name: Run Snyk Security Scan
       uses: snyk/actions/node@master
       continue-on-error: true

README.md

@@ -59,32 +59,12 @@ The documentation for Nutrient DWS TypeScript Client is also available on [Conte
 
 ## Quick Start
 
-## Authentication
-
-### Direct API Key
-
-Provide your API key directly:
-
 ```typescript
 const client = new NutrientClient({
   apiKey: 'nutr_sk_your_secret_key'
 });
 ```
 
-### Token Provider
-
-Use an async token provider to fetch tokens from a secure source:
-
-```typescript
-const client = new NutrientClient({
-  apiKey: async () => {
-    const response = await fetch('/api/get-nutrient-token');
-    const { token } = await response.json();
-    return token;
-  }
-});
-```
-
 ## Direct Methods
 
 The client provides numerous methods for document processing:
@@ -103,7 +83,7 @@ const watermarkedDoc = await client.watermarkText('document.pdf', 'CONFIDENTIAL'
 const mergedPdf = await client.merge(['doc1.pdf', 'doc2.pdf', 'doc3.pdf']);
 ```
 
-For a complete list of available methods with examples, see the [Methods Documentation](./METHODS.md).
+For a complete list of available methods with examples, see the [Methods Documentation](docs/METHODS.md).
 
 
 ## Workflow System
@@ -134,7 +114,7 @@ The workflow system follows a staged approach:
 3. Set output format
 4. Execute or perform a dry run
 
-For detailed information about the workflow system, including examples and best practices, see the [Workflow Documentation](./WORKFLOW.md).
+For detailed information about the workflow system, including examples and best practices, see the [Workflow Documentation](docs/WORKFLOW.md).
 
 ## Error Handling
 
@@ -201,7 +181,7 @@ Quick start for contributors:
 3. Use conventional commits for clear change history
 4. Include appropriate tests for new features
 
-For detailed contribution guidelines, see the [Contributing Guide](./CONTRIBUTING.md).
+For detailed contribution guidelines, see the [Contributing Guide](docs/CONTRIBUTING.md).
 
 ## Project Structure
 

context7.json

@@ -2,12 +2,12 @@
   "$schema": "https://context7.com/schema/context7.json",
   "projectTitle": "Nutrient DWS TypeScript Client",
   "description": "Node.js TypeScript client library for Nutrient Document Web Services (DWS) API.\n",
-  "excludeFolders": ["src", "example", ".github"],
-  "excludeFiles": ["CONTRIBUTING.md", "coverage-report.md", "METHODS.md", "README.md", "WORKFLOW.md"],
+  "excludeFolders": ["src", "docs", "example", ".github"],
+  "excludeFiles": ["README.md"],
   "previousVersions": [
     {
       "tag": "v1.0.0",
       "title": "version 1.0.0"
     }
   ]
-}
+}

CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Nutrient DWS TypeScript Client
 
-Thank you for your interest in contributing to the Nutrient DWS TypeScript Client! This document provides a quick overview of our development standards and practices. For more detailed information about the library itself, please refer to the [README](./README.md), [Methods Documentation](./METHODS.md), and [Workflow Documentation](./WORKFLOW.md).
+Thank you for your interest in contributing to the Nutrient DWS TypeScript Client! This document provides a quick overview of our development standards and practices. For more detailed information about the library itself, please refer to the [README](../README.md), [Methods Documentation](METHODS.md), and [Workflow Documentation](WORKFLOW.md).
 
 ## Development Standards
 

METHODS.md renamed to docs/METHODS.md

@@ -19,6 +19,28 @@ Options:
 - `baseUrl` (optional): Custom API base URL (defaults to `https://api.nutrient.io`)
 - `timeout` (optional): Request timeout in milliseconds
 
+#### Authentication
+
+Provide your API key directly:
+
+```typescript
+const client = new NutrientClient({
+  apiKey: 'nutr_sk_your_secret_key'
+});
+```
+
+Or use an async token provider to fetch tokens from a secure source:
+
+```typescript
+const client = new NutrientClient({
+  apiKey: async () => {
+    const response = await fetch('/api/get-nutrient-token');
+    const { token } = await response.json();
+    return token;
+  }
+});
+```
+
 #### Account Methods
 
 ##### getAccountInfo()

WORKFLOW.md renamed to docs/WORKFLOW.md

@@ -1,2 +1,3 @@
 # Nutrient DWS Processor API Key
-NUTRIENT_API_KEY=your_api_key_here
+NUTRIENT_API_KEY=your_api_key_here
+NODE_ENV=development

examples/.env.example

@@ -98,5 +98,5 @@ All processed files will be saved to the `output/` directory. You can examine th
 For more information about the Nutrient DWS TypeScript Client, refer to:
 
 - [README.md](../README.md) - Main documentation
-- [METHODS.md](../METHODS.md) - Direct methods documentation
-- [WORKFLOW.md](../WORKFLOW.md) - Workflow system documentation
+- [METHODS.md](../docs/METHODS.md) - Direct methods documentation
+- [WORKFLOW.md](../docs/WORKFLOW.md) - Workflow system documentation