docworks 0.11.0-next.1

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "docworks",
+  "version": "0.11.0-next.1",
+  "description": "Ensure your docs work for developers and AI",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "docworks": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "eslint . --ext .ts,.tsx",
+    "lint:fix": "eslint . --ext .ts,.tsx --fix",
+    "type-check": "tsc --noEmit",
+    "check:all": "pnpm run build && pnpm run format && pnpm run lint && pnpm run type-check"
+  },
+  "dependencies": {
+    "@anthropic-ai/sdk": "^0.20.0",
+    "chalk": "^5.0.0",
+    "commander": "^11.0.0",
+    "glob": "^10.0.0",
+    "openai": "^4.0.0",
+    "yaml": "^2.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.35.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/exec": "^7.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.42.0",
+    "@typescript-eslint/parser": "^8.42.0",
+    "eslint": "^9.35.0",
+    "eslint-config-prettier": "^10.1.8",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.1.6",
+    "node": "link:@@types/node",
+    "prettier": "^3.6.2",
+    "semantic-release": "^24.2.7",
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.42.0"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "eslint --fix",
+      "prettier --write"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "prettier --write"
+    ]
+  },
+  "keywords": [
+    "documentation",
+    "regression",
+    "testing",
+    "ci",
+    "api-docs"
+  ],
+  "author": "caiopizzol",
+  "license": "MIT",
+  "homepage": "https://github.com/caiopizzol/docworks",
+  "bugs": "https://github.com/caiopizzol/docworks/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/caiopizzol/docworks.git",
+    "directory": "packages/cli"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/templates/api.yml

@@ -0,0 +1,21 @@
+# DocWorks Configuration - API Documentation
+source: ./llms.txt
+
+journeys:
+  authentication:
+    - How do I authenticate?
+    - Where do I get API keys?
+    - 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

package/templates/default.yml

@@ -0,0 +1,19 @@
+# DocWorks Configuration
+source: ./llms.txt
+
+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?
+
+# AI Provider (openai or anthropic)
+provider: openai
+model: gpt-4o-mini
+# Optional: Set API key here instead of environment variable
+# api_key: sk-...

package/templates/gitbook.yml

@@ -0,0 +1,13 @@
+# DocWorks Configuration - GitBook
+source:
+  type: mcp
+  server: '@gitbook/mcp-server'
+
+journeys:
+  knowledge_base:
+    - Is content organized logically?
+    - Can I search effectively?
+    - Are guides comprehensive?
+
+provider: openai
+model: gpt-4o-mini

package/templates/library.yml

@@ -0,0 +1,21 @@
+# 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

package/templates/mintlify.yml

@@ -0,0 +1,18 @@
+# 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

package/templates/readme.yml

@@ -0,0 +1,13 @@
+# 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