create-dox 0.3.0 → 0.3.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ekene Eze
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# create-dox
+
+Scaffold a new [Dox](https://github.com/kenny-io/Dox) documentation project — an
+agent-native docs site that serves every page to humans as polished HTML and to
+AI agents as structured JSON, JSON-LD, and Markdown from the same URL.
+
+## Quick start
+
+```bash
+npx create-dox my-docs
+cd my-docs
+npm run dev
+```
+
+Then open [http://localhost:3040](http://localhost:3040). A freshly scaffolded
+site is agent-ready out of the box and scores 100/A on the built-in
+[Agent Readiness Score](https://github.com/kenny-io/Dox).
+
+Run non-interactively with smart defaults:
+
+```bash
+npx create-dox my-docs --yes
+```
+
+## What you get
+
+- **MDX content** in `src/content/`, navigation in `docs.json`
+- **Agent endpoints** — `/llms.txt`, `/ai.txt`, `/api/docs-index`, `/api/agent-readiness`
+- **Hybrid search**, **retrieval-grounded AI chat**, and an **admin analytics** dashboard
+- **Starter content** with keywords and structured pages, ready to edit
+
+## Other commands
+
+| Command | What it does |
+| --- | --- |
+| `create-dox <dir>` | Scaffold a new project |
+| `create-dox migrate <github-url> [dir]` | Import docs from a GitHub repo (Mintlify, Docusaurus, GitBook, Nextra, …) |
+| `create-dox check [dir] [--fix]` | Lint content for orphan pages and missing frontmatter |
+| `create-dox translate --locale <code>` | Translate content into another locale |
+
+Prefer a single binary? Install [`@doxlabs/cli`](https://www.npmjs.com/package/@doxlabs/cli)
+and use `dox init`, which delegates here.
+
+## License
+
+MIT

package/dist/{chunk-UCHJJQVK.js → chunk-673L75C2.js}

@@ -43,35 +43,70 @@ import { execSync } from "child_process";
 var STARTER_PAGES = {
   "introduction.mdx": `---
 title: Introduction
-description: Welcome to {NAME} documentation.
+description: Welcome to {NAME} \u2014 learn what it does, how the docs are organized, and where to start.
+keywords:
+  - {NAME}
+  - documentation
+  - overview
+  - getting started
 ---
 
 ## Welcome
 
-This is the home page of your **{NAME}** documentation site, powered by [Dox](https://github.com/kenny-io/Dox).
+Welcome to the **{NAME}** documentation. This is your home base for guides, API
+references, and everything you need to build with {NAME}. The site is powered by
+[Dox](https://github.com/kenny-io/Dox), an agent-native docs platform \u2014 every page
+is served to humans as polished HTML and to AI agents as structured JSON, JSON-LD,
+and Markdown from the same URL, so assistants can read your docs accurately.
 
-Get started by editing this file at \`src/content/introduction.mdx\`.
+## What you'll find here
+
+- **Guides** \u2014 step-by-step walkthroughs of common tasks and workflows.
+- **API reference** \u2014 generated from your OpenAPI spec, with a live "Try It" console.
+- **Quickstart** \u2014 install {NAME} and make your first call in a few minutes.
+
+## Next steps
+
+Start with the [Quickstart](/quickstart) to get {NAME} running, then make this site
+your own by editing \`src/content/introduction.mdx\` and updating the navigation in
+\`docs.json\`. Every change you save is instantly reflected for both readers and agents.
 `,
   "quickstart.mdx": `---
 title: Quickstart
-description: Get up and running with {NAME} in under 5 minutes.
+description: Install {NAME}, configure your API key, and make your first call in under five minutes.
+keywords:
+  - {NAME}
+  - quickstart
+  - installation
+  - getting started
 ---
 
 ## Installation
 
+Install {NAME} with your package manager of choice. We recommend pinning the
+version in your project so builds stay reproducible across machines and CI:
+
 \`\`\`bash
 npm install {SLUG}
 \`\`\`
 
 ## Basic usage
 
+Import the client and initialize it with your API key. Keep the key in an
+environment variable rather than committing it to source control, so it never
+leaks into your repository or build logs:
+
 \`\`\`ts
 import { create } from '{SLUG}'
 
-const client = create({ apiKey: 'your-api-key' })
+const client = create({ apiKey: process.env.API_KEY })
 \`\`\`
 
-That's it \u2014 you're ready to go!
+## What's next
+
+That's the basics \u2014 you're ready to build. Explore the guides for common workflows,
+open the API reference to try endpoints against a live "Try It" console, or edit this
+page at \`src/content/quickstart.mdx\` to document your own onboarding flow.
 `
 };
 function buildStarterDocsJson({

package/dist/{chunk-HHVOU4Q2.js → chunk-AFJGDIXU.js}

@@ -3,7 +3,7 @@ import {
   initGit,
   installDeps,
   scaffold
-} from "./chunk-UCHJJQVK.js";
+} from "./chunk-673L75C2.js";
 
 // src/migrate/index.ts
 import { mkdirSync as mkdirSync2, copyFileSync as copyFileSync2, readFileSync as readFileSync3, writeFileSync, existsSync as existsSync3, mkdtempSync, rmSync } from "fs";

package/dist/index.js

@@ -2,13 +2,13 @@
 import {
   migrateDocs,
   parseGitHubUrl
-} from "./chunk-HHVOU4Q2.js";
+} from "./chunk-AFJGDIXU.js";
 import {
   logo,
   scaffold,
   slugify,
   success
-} from "./chunk-UCHJJQVK.js";
+} from "./chunk-673L75C2.js";
 
 // src/index.ts
 import { existsSync as existsSync3, readdirSync as readdirSync2 } from "fs";

package/dist/migrate/index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 import {
   migrateDocs
-} from "../chunk-HHVOU4Q2.js";
-import "../chunk-UCHJJQVK.js";
+} from "../chunk-AFJGDIXU.js";
+import "../chunk-673L75C2.js";
 export {
   migrateDocs
 };

package/dist/scaffold.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   scaffold
-} from "./chunk-UCHJJQVK.js";
+} from "./chunk-673L75C2.js";
 export {
   scaffold
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-dox",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Scaffold a new Dox documentation project",
   "type": "module",
   "engines": {
@@ -15,7 +15,9 @@
     "./package.json": "./package.json"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE"
   ],
   "scripts": {
     "build": "tsup",
@@ -33,5 +35,18 @@
     "@types/tar": "^6.1.13",
     "tsup": "^8.0.0",
     "typescript": "^5.0.0"
-  }
+  },
+  "license": "MIT",
+  "keywords": [
+    "dox",
+    "documentation",
+    "docs",
+    "scaffold",
+    "mdx",
+    "nextjs",
+    "ai",
+    "agent-native",
+    "mcp",
+    "create"
+  ]
 }