docworks 0.11.0 → 0.12.0

package/README.md

@@ -1,200 +1,138 @@
-<img width="150" height="62" alt="logo-light" src="https://github.com/user-attachments/assets/a538da6b-3443-45d3-bc25-1604ea3b31b1" />
-<br/><br/>
+# DocWorks
 
-Ensure your docs answer critical questions. AI-powered validation that checks if developers can actually find what they need.
+Ensure your docs work for developers and AI. Tests if humans and AI agents can actually accomplish tasks using your documentation.
 
-## The Problem
-
-Your docs mention "authentication" 50 times, but developers still can't figure out HOW to authenticate. Keywords exist, but answers are fragmented across pages. Support tickets spike.
-
-## How It Works
-
-Define what questions your docs must answer. DocWorks uses AI to verify they remain answerable after every change.
-
-```yaml
-# docworks.yml
-questions:
-  critical:
-    - How do I authenticate?
-    - What are the rate limits?
-    - How do I handle errors?
-```
-
-## Install
+## Quick Start
 
 ```bash
+# Install
 npm install -g docworks
-```
-
-## Quick Start
 
-```bash
-# 1. Initialize with smart defaults
+# Initialize
 docworks init
 
-# 2. Check your docs (with your OpenAI key)
+# Run validation
 OPENAI_API_KEY=sk-... docworks check
 ```
 
-Output:
-
-```
-✅ How do I authenticate?
-✅ What are the rate limits?
-❌ How do I handle errors?
-
-Documentation check failed:
-Critical questions cannot be answered from current docs
-```
+## How It Works
 
-## CI/CD Integration
+DocWorks tests documentation the way developers actually use it - by having AI search and navigate your docs to answer questions:
 
-```yaml
-# .github/workflows/docs.yml
-name: Documentation Check
-on: [pull_request]
-
-jobs:
-  check:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - run: npx docworks check
-        env:
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
-```
+1. **AI explores your docs** - Uses web search to navigate pages
+2. **Tracks the journey** - Records which pages were visited
+3. **Reports confidence** - Shows how easily answers were found
+4. **Identifies gaps** - Lists exactly what's missing
 
 ## Configuration
 
+### Simple Questions
+
 ```yaml
 # docworks.yml
-questions:
-  critical: # These block PRs if unanswerable
-    - How do I install this?
-    - How do I authenticate?
+source: https://docs.yourcompany.com
 
-  important: # These warn but don't block
-    - How do I debug issues?
-    - What are the rate limits?
-
-  nice_to_have: # Informational only
-    - Are there TypeScript types?
+questions:
+  - How do I authenticate?
+  - What are the rate limits?
+  - Where are code examples?
 
-# Optional: Use your preferred AI provider
-provider: openai # or anthropic, azure
+provider: openai
 model: gpt-4o-mini
 ```
 
-## Templates
+### Journey Validation
 
-Start quickly with pre-built templates:
+```yaml
+source: https://docs.yourcompany.com
 
-```bash
-# API documentation
-docworks init --template api
+journeys:
+  authentication:
+    - How do I get API keys?
+    - How do I authenticate requests?
+    - How do I handle token refresh?
 
-# NPM package
-docworks init --template library
+  error_handling:
+    - What are the error codes?
+    - How do I retry failed requests?
 
-# Internal platform
-docworks init --template internal
+provider: openai
+model: gpt-4o-mini
 ```
 
-## Why DocWorks?
-
-- **Explicit control** - You define what matters, not magic patterns
-- **AI-powered** - Understands context, not just keywords
-- **Progressive adoption** - Start advisory, enable blocking when ready
-- **Provider flexible** - OpenAI, Anthropic, Azure (BYO keys)
-- **Fast** - Cached responses, parallel validation
-
-## Examples
-
-### API Documentation
-
-```yaml
-questions:
-  critical:
-    - How do I authenticate with the API?
-    - What are the API endpoints?
-    - How do I handle errors?
-```
+## Rich Feedback
 
-### Library/Package
+Instead of simple YES/NO, get actionable insights:
 
-```yaml
-questions:
-  critical:
-    - How do I install this package?
-    - How do I import and use it?
-    - What's a basic example?
 ```
-
-### Internal Docs
-
-```yaml
-questions:
-  critical:
-    - How do I get access?
-    - Who do I contact for help?
-    - Where are the runbooks?
+⚠️ How do I authenticate?
+   Confidence: 60%
+   Searched: 3 pages
+   Missing:
+     - API key generation steps
+     - Token refresh documentation
 ```
 
-## How It Really Works
+## Multi-Model Testing
 
-1. **You define questions** your docs must answer
-2. **DocWorks reads** all your documentation
-3. **AI validates** each question is answerable
-4. **CI/CD enforces** on every PR
+Test against multiple AI models using CI/CD:
 
-No keyword matching. No regex patterns. Just: "Can a developer find this answer?"
+```yaml
+# .github/workflows/docs.yml
+name: Documentation Validation
+on: [pull_request]
 
-## Requirements
+jobs:
+  validate:
+    strategy:
+      matrix:
+        include:
+          - provider: openai
+            model: gpt-4o
+          - provider: openai
+            model: gpt-4o-mini
+          - provider: anthropic
+            model: claude-3-opus
 
-- Node.js 16+
-- OpenAI API key (or Anthropic, Azure)
-- Documentation in Markdown
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - run: npx docworks check
+        env:
+          PROVIDER: ${{ matrix.provider }}
+          MODEL: ${{ matrix.model }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+```
 
-## Pricing
+## Supported Documentation
 
-- **DocWorks**: Free, open source, MIT licensed
-- **AI costs**: ~$0.01 per check with caching (you pay provider directly)
+- **Public docs** - Any site with [llms.txt](https://llmstxt.org)
+- **Platforms** - Mintlify, ReadMe, GitBook
 
-## Development
+## Commands
 
 ```bash
-# Clone and install
-git clone https://github.com/caiopizzol/docworks
-cd docworks
-npm install
-
-# Run locally
-npm run dev
-
-# Run tests
-npm test
-```
+# Initialize config
+docworks init
 
-## FAQ
+# Validate all journeys
+docworks check
 
-**Q: Will this block my PRs?**  
-A: Not by default. Starts in advisory mode. Enable blocking when ready.
+# Test specific journey
+docworks check --journey authentication
 
-**Q: What if the AI is wrong?**  
-A: Adjust confidence thresholds, use advisory mode, or override specific questions.
+# Output as JSON
+docworks check --format json
+```
 
-**Q: Can I use this with private docs?**  
-A: Yes. Runs in your CI with your API keys. Docs never leave your infrastructure.
+## Why DocWorks?
 
-**Q: Does it support other languages?**  
-A: Currently Markdown/MDX. More formats coming soon.
+- **Real-world testing** - AI navigates docs like developers do
+- **Actionable feedback** - Know exactly what to fix
+- **CI/CD ready** - Catch doc regressions before merge
+- **Progressive** - Start simple, add complexity as needed
 
 ## License
 
 MIT
-
-## Links
-
-- [Documentation](https://docworks.dev)
-- [GitHub](https://github.com/caiopizzol/docworks)
-- [NPM](https://npmjs.com/package/docworks)

package/dist/commands/check.d.ts

@@ -1,7 +1,8 @@
 export declare function check(options: {
     config: string;
     journey?: string;
-    cache?: boolean;
-    format?: 'terminal' | 'json' | 'github';
+    format?: 'terminal' | 'json';
+    provider?: string;
+    model?: string;
 }): Promise<void>;
 //# sourceMappingURL=check.d.ts.map

package/dist/commands/check.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAMA,wBAAsB,KAAK,CAAC,OAAO,EAAE;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAA;CACxC,GAAG,OAAO,CAAC,IAAI,CAAC,CA2EhB"}
+{"version":3,"file":"check.d.ts","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AAMA,wBAAsB,KAAK,CAAC,OAAO,EAAE;IACnC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,UAAU,GAAG,MAAM,CAAA;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,GAAG,OAAO,CAAC,IAAI,CAAC,CA6FhB"}

package/dist/commands/check.js

@@ -1,11 +1,16 @@
 import { loadConfig } from '../utils/config.js';
-import { createSource } from '../sources/base.js';
+import { fetchDocumentation } from '../sources/source.js';
 import { validateJourneys, validateQuestions } from '../core/validator.js';
 import { formatReport, formatJSON } from '../utils/reporter.js';
 export async function check(options) {
     try {
         // Load config
         const config = await loadConfig(options.config || 'docworks.yml');
+        // Apply overrides
+        if (options.provider)
+            config.provider = options.provider;
+        if (options.model)
+            config.model = options.model;
         // Validate API key
         const apiKey = process.env.OPENAI_API_KEY ||
             process.env.ANTHROPIC_API_KEY ||
@@ -19,15 +24,29 @@ export async function check(options) {
         }
         // Load documentation
         console.log('📚 Loading documentation...');
-        const source = await createSource(config);
-        console.log(`Source: ${source.name}\n`);
-        const docs = await source.fetch();
-        // Validate journeys
-        console.log('🔍 Validating journeys...\n');
+        const { content: docs, name: sourceName } = await fetchDocumentation(config.source);
+        console.log(`Source: ${sourceName}\n`);
+        // Prepare all validations
+        const allValidations = {};
+        // Add standalone questions as implicit "general" journey
+        if (config.questions) {
+            allValidations.general = config.questions;
+        }
+        // Add explicit journeys
+        if (config.journeys) {
+            Object.assign(allValidations, config.journeys);
+        }
+        // Check if we have anything to validate
+        if (Object.keys(allValidations).length === 0) {
+            console.error('❌ No questions or journeys found in config');
+            process.exit(1);
+        }
+        // Validate
+        console.log('🔍 Validating documentation...\n');
         let results;
         if (options.journey) {
             // Validate single journey
-            const questions = config.journeys[options.journey];
+            const questions = allValidations[options.journey];
             if (!questions) {
                 console.error(`Journey "${options.journey}" not found`);
                 process.exit(1);
@@ -35,21 +54,21 @@ export async function check(options) {
             console.log(`Journey: ${options.journey}`);
             console.log('─'.repeat(40));
             results = {
-                [options.journey]: await validateQuestions(questions, docs, apiKey, options.cache !== false),
+                [options.journey]: await validateQuestions(questions, docs, apiKey, config),
             };
         }
         else {
-            // Validate all journeys
-            results = await validateJourneys(config.journeys, docs, apiKey, options.cache !== false);
+            // Validate all
+            results = await validateJourneys(allValidations, docs, apiKey, config);
         }
         // Format output
         if (options.format === 'json') {
-            console.log(formatJSON(results, source.name));
+            console.log(formatJSON(results, sourceName));
             const hasFailures = Object.values(results).some((questions) => questions.some((q) => q.answerable === 'NO'));
             process.exit(hasFailures ? 1 : 0);
         }
         else {
-            const exitCode = formatReport(results, options.format === 'github');
+            const exitCode = formatReport(results);
             process.exit(exitCode);
         }
     }

package/dist/commands/check.js.map

@@ -1 +1 @@
-{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAE/D,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAK3B;IACC,IAAI,CAAC;QACH,cAAc;QACd,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,CAAA;QAEjE,mBAAmB;QACnB,MAAM,MAAM,GACV,OAAO,CAAC,GAAG,CAAC,cAAc;YAC1B,OAAO,CAAC,GAAG,CAAC,iBAAiB;YAC7B,MAAM,CAAC,OAAO,CAAA;QAEhB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YACrC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;YAC5B,OAAO,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAA;YAC/C,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAA;YACtD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;QAED,qBAAqB;QACrB,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QAC1C,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;QACzC,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,CAAC,IAAI,IAAI,CAAC,CAAA;QAEvC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;QAEjC,oBAAoB;QACpB,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QAE1C,IAAI,OAAuB,CAAA;QAE3B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,0BAA0B;YAC1B,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YAClD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,YAAY,OAAO,CAAC,OAAO,aAAa,CAAC,CAAA;gBACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,YAAY,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;YAC1C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;YAE3B,OAAO,GAAG;gBACR,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,iBAAiB,CACxC,SAAS,EACT,IAAI,EACJ,MAAM,EACN,OAAO,CAAC,KAAK,KAAK,KAAK,CACxB;aACF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,wBAAwB;YACxB,OAAO,GAAG,MAAM,gBAAgB,CAC9B,MAAM,CAAC,QAAQ,EACf,IAAI,EACJ,MAAM,EACN,OAAO,CAAC,KAAK,KAAK,KAAK,CACxB,CAAA;QACH,CAAC;QAED,gBAAgB;QAChB,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;YAC7C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAC5D,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,CAC7C,CAAA;YACD,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAA;YACnE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACxB,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,UAAU,EAAG,KAAe,CAAC,OAAO,CAAC,CAAA;QACnD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC"}
+{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/commands/check.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC1E,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAE/D,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAM3B;IACC,IAAI,CAAC;QACH,cAAc;QACd,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,IAAI,cAAc,CAAC,CAAA;QAEjE,kBAAkB;QAClB,IAAI,OAAO,CAAC,QAAQ;YAAE,MAAM,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QACxD,IAAI,OAAO,CAAC,KAAK;YAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;QAE/C,mBAAmB;QACnB,MAAM,MAAM,GACV,OAAO,CAAC,GAAG,CAAC,cAAc;YAC1B,OAAO,CAAC,GAAG,CAAC,iBAAiB;YAC7B,MAAM,CAAC,OAAO,CAAA;QAEhB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAA;YACrC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;YAC5B,OAAO,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAA;YAC/C,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAA;YACtD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;QAED,qBAAqB;QACrB,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QAC1C,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,MAAM,kBAAkB,CAClE,MAAM,CAAC,MAAM,CACd,CAAA;QACD,OAAO,CAAC,GAAG,CAAC,WAAW,UAAU,IAAI,CAAC,CAAA;QAEtC,0BAA0B;QAC1B,MAAM,cAAc,GAA6B,EAAE,CAAA;QAEnD,yDAAyD;QACzD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,cAAc,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,CAAA;QAC3C,CAAC;QAED,wBAAwB;QACxB,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAA;QAChD,CAAC;QAED,wCAAwC;QACxC,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7C,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACjB,CAAC;QAED,WAAW;QACX,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAA;QAE/C,IAAI,OAAuB,CAAA;QAE3B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,0BAA0B;YAC1B,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;YACjD,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,YAAY,OAAO,CAAC,OAAO,aAAa,CAAC,CAAA;gBACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACjB,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,YAAY,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;YAC1C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAA;YAE3B,OAAO,GAAG;gBACR,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,iBAAiB,CACxC,SAAS,EACT,IAAI,EACJ,MAAM,EACN,MAAM,CACP;aACF,CAAA;QACH,CAAC;aAAM,CAAC;YACN,eAAe;YACf,OAAO,GAAG,MAAM,gBAAgB,CAAC,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;QACxE,CAAC;QAED,gBAAgB;QAChB,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAA;YAC5C,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAC5D,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,CAC7C,CAAA;YACD,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;YACtC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACxB,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,UAAU,EAAG,KAAe,CAAC,OAAO,CAAC,CAAA;QACnD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;AACH,CAAC"}

package/dist/commands/init.d.ts

@@ -1,5 +1,4 @@
 export declare function init(options: {
     template?: string;
-    platform?: string;
 }): Promise<void>;
 //# sourceMappingURL=init.d.ts.map

package/dist/commands/init.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAkHA,wBAAsB,IAAI,CAAC,OAAO,EAAE;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAqChB"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAsCA,wBAAsB,IAAI,CAAC,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAiCxE"}

package/dist/commands/init.js

@@ -1,108 +1,37 @@
 import fs from 'fs';
-import { glob } from 'glob';
 const TEMPLATES = {
-    default: `# DocWorks Configuration
-source: ./llms.txt
+    simple: `# DocWorks Configuration
+source: https://docs.example.com
 
-journeys:
-  getting_started:
-    - How do I install this?
-    - How do I get started?
-    - Where are examples?
-    
-  development:
-    - How do I run tests?
-    - How do I debug issues?
-    - Where can I get help?
+# Simple list of questions to validate
+questions:
+  - How do I authenticate?
+  - What are the rate limits?
+  - How do I get started?
+  - Where can I find examples?
+  - How do I handle errors?
 
-provider: openai
-model: gpt-4o-mini`,
-    api: `# DocWorks Configuration - API Documentation
-source: ./llms.txt
+# Provider configuration (supports environment variables)
+provider: \${PROVIDER:-openai}
+model: \${MODEL:-gpt-4o-mini}`,
+    journeys: `# DocWorks Configuration
+source: https://docs.example.com
 
+# Group questions by user journey
 journeys:
   authentication:
-    - How do I authenticate?
-    - Where do I get API keys?
+    - How do I get API keys?
+    - How do I authenticate requests?
     - What auth methods are supported?
     
-  integration:
-    - What are the endpoints?
-    - How do I handle errors?
-    - What are the rate limits?
-    
-  production:
-    - How do I monitor usage?
-    - Where are status pages?
-    - How do I get support?
-
-provider: openai
-model: gpt-4o-mini`,
-    library: `# DocWorks Configuration - Library/Package
-source: ./llms.txt
-
-journeys:
-  setup:
-    - How do I install this package?
-    - How do I import it?
-    - What are the requirements?
-    
-  basic_usage:
-    - What's a hello world example?
-    - What are the main functions?
-    - How do I configure options?
-    
-  typescript:
-    - Does it have TypeScript support?
-    - Where are the type definitions?
-    - How do I use with TypeScript?
-
-provider: openai
-model: gpt-4o-mini`,
-    mintlify: `# DocWorks Configuration - Mintlify
-source:
-  type: mcp
-  server: "@mintlify/mcp-server"
-
-journeys:
-  api_reference:
-    - Where is the API reference?
-    - Are all endpoints documented?
-    - Do examples work?
-    
-  getting_started:
-    - Is there a quickstart guide?
-    - How do I authenticate?
-    - What SDKs are available?
-
-provider: openai
-model: gpt-4o-mini`,
-    readme: `# DocWorks Configuration - ReadMe
-source:
-  type: mcp
-  server: "@readme/mcp-server"
-
-journeys:
-  developer_experience:
-    - Can I try the API interactively?
-    - Are there code examples?
-    - Is versioning documented?
-
-provider: openai
-model: gpt-4o-mini`,
-    gitbook: `# DocWorks Configuration - GitBook
-source:
-  type: mcp
-  server: "@gitbook/mcp-server"
+  error_handling:
+    - What error codes exist?
+    - How should I handle rate limits?
+    - Where are error examples?
 
-journeys:
-  knowledge_base:
-    - Is content organized logically?
-    - Can I search effectively?
-    - Are guides comprehensive?
-
-provider: openai
-model: gpt-4o-mini`,
+# Provider configuration (supports environment variables)
+provider: \${PROVIDER:-openai}
+model: \${MODEL:-gpt-4o-mini}`,
 };
 export async function init(options) {
     console.log('🚀 Initializing DocWorks...\n');
@@ -112,54 +41,25 @@ export async function init(options) {
         process.exit(1);
     }
     // Select template
-    const templateName = options.platform || options.template || 'default';
+    const templateName = options.template || 'simple';
     const template = TEMPLATES[templateName];
     if (!template) {
         console.error(`Unknown template: ${templateName}`);
-        console.log('Available: default, api, library, mintlify, readme, gitbook');
+        console.log('Available: simple, journeys');
         process.exit(1);
     }
-    // Create llms.txt if needed (not for MCP platforms)
-    if (!options.platform && !fs.existsSync('llms.txt')) {
-        await createLLMSTxt();
-    }
     // Write config
     fs.writeFileSync('docworks.yml', template);
     console.log('✅ Created docworks.yml\n');
     // Next steps
     console.log('Next steps:');
-    if (!options.platform) {
-        console.log('1. Review llms.txt - ensure all docs are listed');
-    }
-    console.log('2. Set your API key:');
+    console.log('1. Update the source URL to your documentation');
+    console.log('2. Customize the questions for your needs');
+    console.log('3. Set your API key:');
     console.log('   export OPENAI_API_KEY=sk-...');
-    console.log('3. Run validation:');
+    console.log('   # or for Anthropic:');
+    console.log('   export ANTHROPIC_API_KEY=sk-ant-...');
+    console.log('4. Run validation:');
     console.log('   docworks check');
 }
-async function createLLMSTxt() {
-    console.log('📝 Creating llms.txt...');
-    // Find common documentation files
-    const patterns = ['README.md', 'readme.md', 'docs/**/*.md', '*.md'];
-    const files = new Set();
-    for (const pattern of patterns) {
-        const matches = await glob(pattern, {
-            ignore: ['node_modules/**', '.git/**', 'CHANGELOG.md'],
-        });
-        matches.forEach((file) => files.add(file));
-    }
-    const content = [
-        '# Documentation sources for DocWorks',
-        '# Add your documentation files below, one per line',
-        '# Lines starting with # are comments',
-        '',
-        ...Array.from(files).slice(0, 20), // Limit initial list
-        '',
-        '# Add more files as needed:',
-        '# docs/api/authentication.md',
-        '# examples/quickstart.js',
-        '# https://api.example.com/openapi.json',
-    ].join('\n');
-    fs.writeFileSync('llms.txt', content);
-    console.log(`✅ Created llms.txt with ${files.size} documentation files\n`);
-}
 //# sourceMappingURL=init.js.map

package/dist/commands/init.js.map

@@ -1 +1 @@
-{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAE3B,MAAM,SAAS,GAAG;IAChB,OAAO,EAAE;;;;;;;;;;;;;;;mBAeQ;IAEjB,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;mBAoBY;IAEjB,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;mBAoBQ;IAEjB,QAAQ,EAAE;;;;;;;;;;;;;;;;;mBAiBO;IAEjB,MAAM,EAAE;;;;;;;;;;;;mBAYS;IAEjB,OAAO,EAAE;;;;;;;;;;;;mBAYQ;CAClB,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAG1B;IACC,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAA;IAE5C,wBAAwB;IACxB,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;QAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,kBAAkB;IAClB,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,IAAI,SAAS,CAAA;IACtE,MAAM,QAAQ,GAAG,SAAS,CAAC,YAAsC,CAAC,CAAA;IAElE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,qBAAqB,YAAY,EAAE,CAAC,CAAA;QAClD,OAAO,CAAC,GAAG,CAAC,6DAA6D,CAAC,CAAA;QAC1E,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,oDAAoD;IACpD,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QACpD,MAAM,aAAa,EAAE,CAAA;IACvB,CAAC;IAED,eAAe;IACf,EAAE,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IAC1C,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;IAEvC,aAAa;IACb,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IAC1B,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAA;IAChE,CAAC;IACD,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;IACnC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;IAC9C,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;IACjC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AAClC,CAAC;AAED,KAAK,UAAU,aAAa;IAC1B,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAA;IAEtC,kCAAkC;IAClC,MAAM,QAAQ,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,CAAA;IAEnE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAA;IAC/B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE;YAClC,MAAM,EAAE,CAAC,iBAAiB,EAAE,SAAS,EAAE,cAAc,CAAC;SACvD,CAAC,CAAA;QACF,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;IAC5C,CAAC;IAED,MAAM,OAAO,GAAG;QACd,sCAAsC;QACtC,oDAAoD;QACpD,sCAAsC;QACtC,EAAE;QACF,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,qBAAqB;QACxD,EAAE;QACF,6BAA6B;QAC7B,8BAA8B;QAC9B,0BAA0B;QAC1B,wCAAwC;KACzC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEZ,EAAE,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;IACrC,OAAO,CAAC,GAAG,CAAC,2BAA2B,KAAK,CAAC,IAAI,wBAAwB,CAAC,CAAA;AAC5E,CAAC"}
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,MAAM,SAAS,GAAG;IAChB,MAAM,EAAE;;;;;;;;;;;;;8BAaoB;IAE5B,QAAQ,EAAE;;;;;;;;;;;;;;;;;8BAiBkB;CAC7B,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAA8B;IACvD,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAA;IAE5C,wBAAwB;IACxB,IAAI,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;QAC9C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,kBAAkB;IAClB,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,IAAI,QAAQ,CAAA;IACjD,MAAM,QAAQ,GAAG,SAAS,CAAC,YAAsC,CAAC,CAAA;IAElE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,CAAC,KAAK,CAAC,qBAAqB,YAAY,EAAE,CAAC,CAAA;QAClD,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;QAC1C,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IAED,eAAe;IACf,EAAE,CAAC,aAAa,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IAC1C,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;IAEvC,aAAa;IACb,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;IAC1B,OAAO,CAAC,GAAG,CAAC,gDAAgD,CAAC,CAAA;IAC7D,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAA;IACxD,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAA;IACnC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;IAC9C,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;IACrC,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAA;IACrD,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;IACjC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAA;AAClC,CAAC"}

package/dist/core/validator.d.ts

@@ -1,4 +1,4 @@
-import { ValidationResult, JourneyResults } from '../types/config.js';
-export declare function validateJourneys(journeys: Record<string, string[]>, docs: string, apiKey: string, useCache?: boolean): Promise<JourneyResults>;
-export declare function validateQuestions(questions: string[], docs: string, apiKey: string, useCache?: boolean): Promise<ValidationResult[]>;
+import { ValidationResult, JourneyResults, DocWorksConfig } from '../types/config.js';
+export declare function validateJourneys(journeys: Record<string, string[]>, docs: string, apiKey: string, config?: DocWorksConfig): Promise<JourneyResults>;
+export declare function validateQuestions(questions: string[], docs: string, apiKey: string, config?: DocWorksConfig): Promise<ValidationResult[]>;
 //# sourceMappingURL=validator.d.ts.map

package/dist/core/validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/core/validator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAIrE,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,UAAO,GACd,OAAO,CAAC,cAAc,CAAC,CAazB;AAED,wBAAsB,iBAAiB,CACrC,SAAS,EAAE,MAAM,EAAE,EACnB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,QAAQ,UAAO,GACd,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA4C7B"}
+{"version":3,"file":"validator.d.ts","sourceRoot":"","sources":["../../src/core/validator.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,cAAc,EACf,MAAM,oBAAoB,CAAA;AAG3B,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAClC,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,cAAc,GACtB,OAAO,CAAC,cAAc,CAAC,CAQzB;AAED,wBAAsB,iBAAiB,CACrC,SAAS,EAAE,MAAM,EAAE,EACnB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,cAAc,GACtB,OAAO,CAAC,gBAAgB,EAAE,CAAC,CA+B7B"}