@latent-space-labs/open-auto-doc 0.3.2 → 0.3.3

package/dist/index.js

@@ -555,6 +555,26 @@ async function createCiWorkflow(params) {
     "utf-8"
   );
   p4.log.success(`Created ${path5.relative(gitRoot, workflowPath)}`);
+  if (token) {
+    try {
+      const origin = execSync3("git remote get-url origin", {
+        cwd: gitRoot,
+        encoding: "utf-8",
+        stdio: ["pipe", "pipe", "pipe"]
+      }).trim();
+      const match = origin.match(/github\.com[:/]([^/]+\/[^/.]+?)(?:\.git)?$/);
+      if (match) {
+        const octokit = new Octokit3({ auth: token });
+        await verifySecretsInteractive(octokit, [match[1]]);
+      } else {
+        showSecretsInstructions(false);
+      }
+    } catch {
+      showSecretsInstructions(false);
+    }
+  } else {
+    showSecretsInstructions(false);
+  }
   return { workflowPath, branch };
 }
 async function createCiWorkflowsMultiRepo(params) {
@@ -609,8 +629,92 @@ async function createCiWorkflowsMultiRepo(params) {
     return null;
   }
   p4.log.success(`Created workflows in ${createdRepos.length}/${config.repos.length} repositories`);
+  await verifySecretsInteractive(octokit, createdRepos);
   return { repos: createdRepos, branch };
 }
+var REQUIRED_SECRETS = ["ANTHROPIC_API_KEY", "DOCS_DEPLOY_TOKEN"];
+async function checkSecret(octokit, owner, repo, secretName) {
+  try {
+    await octokit.rest.actions.getRepoSecret({ owner, repo, secret_name: secretName });
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function verifySecretsInteractive(octokit, repos) {
+  const shouldVerify = await p4.confirm({
+    message: "Would you like to verify secrets now? (you can add them later)",
+    initialValue: true
+  });
+  if (p4.isCancel(shouldVerify) || !shouldVerify) {
+    showSecretsInstructions(repos.length > 1);
+    return;
+  }
+  p4.note(
+    [
+      "Each source repo needs two Actions secrets:",
+      "",
+      "  ANTHROPIC_API_KEY   \u2014 Your Anthropic API key",
+      "  DOCS_DEPLOY_TOKEN   \u2014 GitHub PAT with repo scope",
+      "",
+      "To create the PAT:",
+      "  1. Go to https://github.com/settings/tokens",
+      "  2. Generate new token (classic) with 'repo' scope",
+      "  3. Copy the token and add it as DOCS_DEPLOY_TOKEN"
+    ].join("\n"),
+    "Required GitHub Secrets"
+  );
+  const summary = {};
+  for (const fullName of repos) {
+    const [owner, repoName] = fullName.split("/");
+    p4.log.step(`Add secrets to ${fullName}`);
+    p4.log.message(`  https://github.com/${fullName}/settings/secrets/actions`);
+    let allFound = false;
+    while (!allFound) {
+      await p4.text({
+        message: `Press enter when you've added the secrets to ${fullName}...`,
+        defaultValue: "",
+        placeholder: ""
+      });
+      const results = {};
+      for (const secret of REQUIRED_SECRETS) {
+        results[secret] = await checkSecret(octokit, owner, repoName, secret);
+      }
+      for (const secret of REQUIRED_SECRETS) {
+        if (results[secret]) {
+          p4.log.success(`${secret} \u2014 found`);
+        } else {
+          p4.log.warn(`${secret} \u2014 not found`);
+        }
+      }
+      summary[fullName] = results;
+      allFound = REQUIRED_SECRETS.every((s) => results[s]);
+      if (!allFound) {
+        const retry = await p4.confirm({
+          message: "Some secrets are missing. Would you like to try again?",
+          initialValue: true
+        });
+        if (p4.isCancel(retry) || !retry) break;
+      }
+    }
+  }
+  const lines = [];
+  let allGreen = true;
+  for (const fullName of repos) {
+    const parts = REQUIRED_SECRETS.map((s) => {
+      const ok = summary[fullName]?.[s] ?? false;
+      if (!ok) allGreen = false;
+      return ok ? `\u2713 ${s}` : `\u2717 ${s}`;
+    });
+    lines.push(`${fullName}  \u2014 ${parts.join("  ")}`);
+  }
+  if (allGreen) {
+    p4.note(lines.join("\n"), "All secrets verified!");
+  } else {
+    p4.note(lines.join("\n"), "Secret status");
+    p4.log.warn("Some secrets are still missing \u2014 workflows will fail until they are added.");
+  }
+}
 function showSecretsInstructions(multiRepo = false) {
   const repoNote = multiRepo ? "Add these secrets to EACH source repository:" : "Add these secrets to your GitHub repository:";
   p4.note(
@@ -2566,6 +2670,15 @@ function slugify22(name) {
 var __dirname2 = path8.dirname(fileURLToPath2(import.meta.url));
 async function initCommand(options) {
   p5.intro("open-auto-doc \u2014 AI-powered documentation generator");
+  const templateDir = resolveTemplateDir();
+  if (!fs8.existsSync(path8.join(templateDir, "package.json"))) {
+    p5.log.error(
+      `Site template not found at: ${templateDir}
+This usually means the npm package was not built correctly.
+Try reinstalling: npm install -g @latent-space-labs/open-auto-doc`
+    );
+    process.exit(1);
+  }
   let token = getGithubToken();
   if (!token) {
     p5.log.info("Let's connect your GitHub account.");
@@ -2693,8 +2806,6 @@ async function initCommand(options) {
   const genSpinner = p5.spinner();
   try {
     genSpinner.start("Scaffolding documentation site...");
-    const templateDir = resolveTemplateDir();
-    p5.log.info(`Using template from: ${templateDir}`);
     await scaffoldSite(outputDir, projectName, templateDir);
     genSpinner.stop("Site scaffolded");
   } catch (err) {
@@ -2776,23 +2887,25 @@ async function initCommand(options) {
     token,
     config
   });
-  if (ciResult) {
-    showSecretsInstructions(repos.length > 1);
-  }
   showVercelInstructions(deployResult.owner, deployResult.repoName);
   p5.outro(`Docs repo: https://github.com/${deployResult.owner}/${deployResult.repoName}`);
 }
 function resolveTemplateDir() {
   const candidates = [
+    path8.resolve(__dirname2, "site-template"),
+    // dist/site-template (npm global install)
     path8.resolve(__dirname2, "../../site-template"),
+    // monorepo: packages/site-template
     path8.resolve(__dirname2, "../../../site-template"),
+    // monorepo alt
     path8.resolve(__dirname2, "../../../../packages/site-template")
+    // monorepo from nested dist
   ];
   for (const candidate of candidates) {
     const pkgPath = path8.join(candidate, "package.json");
     if (fs8.existsSync(pkgPath)) return candidate;
   }
-  return path8.resolve(__dirname2, "../../site-template");
+  return path8.resolve(__dirname2, "site-template");
 }
 function cleanup(clones) {
   for (const clone of clones) {
@@ -3073,7 +3186,6 @@ async function setupCiCommand() {
     p8.cancel("Setup cancelled.");
     process.exit(0);
   }
-  showSecretsInstructions(isMultiRepo);
   if ("repos" in result) {
     p8.outro("Per-repo CI workflows created! Add the required secrets to each source repo.");
   } else {
@@ -3110,7 +3222,7 @@ async function logoutCommand() {
 
 // src/index.ts
 var program = new Command();
-program.name("open-auto-doc").description("Auto-generate beautiful documentation websites from GitHub repositories using AI").version("0.3.2");
+program.name("open-auto-doc").description("Auto-generate beautiful documentation websites from GitHub repositories using AI").version("0.3.3");
 program.command("init", { isDefault: true }).description("Initialize and generate documentation for your repositories").option("-o, --output <dir>", "Output directory", "docs-site").action(initCommand);
 program.command("generate").description("Regenerate documentation using existing configuration").option("--incremental", "Only re-analyze changed files (uses cached results)").option("--force", "Force full regeneration (ignore cache)").option("--repo <name>", "Only analyze this repo (uses cache for others)").action(generateCommand);
 program.command("deploy").description("Create a GitHub repo for docs and push (connect to Vercel for auto-deploy)").option("-d, --dir <path>", "Docs site directory").action(deployCommand);

package/dist/site-template/app/api/search/route.ts

@@ -0,0 +1,6 @@
+import { source } from "@/lib/source";
+import { createFromSource } from "fumadocs-core/search/server";
+
+export const { GET } = createFromSource(source, {
+  language: "english",
+});

package/dist/site-template/app/docs/[[...slug]]/page.tsx

@@ -0,0 +1,47 @@
+import { source } from "@/lib/source";
+import {
+  DocsBody,
+  DocsDescription,
+  DocsPage,
+  DocsTitle,
+} from "fumadocs-ui/layouts/docs/page";
+import { notFound } from "next/navigation";
+import { getMDXComponents } from "@/mdx-components";
+import type { Metadata } from "next";
+
+export default async function Page(props: {
+  params: Promise<{ slug?: string[] }>;
+}) {
+  const params = await props.params;
+  const page = source.getPage(params.slug);
+  if (!page) notFound();
+
+  const MDX = page.data.body;
+
+  return (
+    <DocsPage toc={page.data.toc} full={page.data.full}>
+      <DocsTitle>{page.data.title}</DocsTitle>
+      <DocsDescription>{page.data.description}</DocsDescription>
+      <DocsBody>
+        <MDX components={getMDXComponents()} />
+      </DocsBody>
+    </DocsPage>
+  );
+}
+
+export async function generateStaticParams() {
+  return source.generateParams();
+}
+
+export async function generateMetadata(props: {
+  params: Promise<{ slug?: string[] }>;
+}): Promise<Metadata> {
+  const params = await props.params;
+  const page = source.getPage(params.slug);
+  if (!page) notFound();
+
+  return {
+    title: page.data.title,
+    description: page.data.description,
+  };
+}

package/dist/site-template/app/docs/layout.tsx

@@ -0,0 +1,12 @@
+import { source } from "@/lib/source";
+import { DocsLayout } from "fumadocs-ui/layouts/docs";
+import { baseOptions } from "@/lib/layout.shared";
+import type { ReactNode } from "react";
+
+export default function Layout({ children }: { children: ReactNode }) {
+  return (
+    <DocsLayout tree={source.getPageTree()} {...baseOptions()}>
+      {children}
+    </DocsLayout>
+  );
+}

package/dist/site-template/app/global.css

@@ -0,0 +1,3 @@
+@import "tailwindcss";
+@import "fumadocs-ui/css/neutral.css";
+@import "fumadocs-ui/css/preset.css";

package/dist/site-template/app/layout.tsx

@@ -0,0 +1,21 @@
+import { RootProvider } from "fumadocs-ui/provider/next";
+import "./global.css";
+import { Inter } from "next/font/google";
+import type { ReactNode } from "react";
+
+const inter = Inter({ subsets: ["latin"] });
+
+export const metadata = {
+  title: "{{projectName}} Documentation",
+  description: "Auto-generated documentation for {{projectName}}",
+};
+
+export default function RootLayout({ children }: { children: ReactNode }) {
+  return (
+    <html lang="en" className={inter.className} suppressHydrationWarning>
+      <body className="flex min-h-screen flex-col">
+        <RootProvider>{children}</RootProvider>
+      </body>
+    </html>
+  );
+}

package/dist/site-template/app/page.tsx

@@ -0,0 +1,5 @@
+import { redirect } from "next/navigation";
+
+export default function RootPage() {
+  redirect("/docs");
+}

package/dist/site-template/components/mermaid.tsx

@@ -0,0 +1,62 @@
+"use client";
+
+import { useEffect, useId, useRef, useState } from "react";
+
+export function Mermaid({ code }: { code: string }) {
+  const id = useId().replace(/:/g, "m");
+  const containerRef = useRef<HTMLDivElement>(null);
+  const [svg, setSvg] = useState<string>("");
+  const [error, setError] = useState<string>("");
+
+  useEffect(() => {
+    let cancelled = false;
+
+    async function render() {
+      try {
+        const mermaid = (await import("mermaid")).default;
+        mermaid.initialize({
+          startOnLoad: false,
+          theme: "neutral",
+          securityLevel: "loose",
+        });
+        const { svg: rendered } = await mermaid.render(
+          `mermaid-${id}`,
+          code,
+        );
+        if (!cancelled) setSvg(rendered);
+      } catch (err) {
+        if (!cancelled)
+          setError(err instanceof Error ? err.message : "Diagram error");
+      }
+    }
+
+    render();
+    return () => {
+      cancelled = true;
+    };
+  }, [code, id]);
+
+  if (error) {
+    return (
+      <pre className="rounded-lg border bg-fd-card p-4 text-sm text-fd-muted-foreground overflow-x-auto">
+        <code>{code}</code>
+      </pre>
+    );
+  }
+
+  if (!svg) {
+    return (
+      <div className="flex items-center justify-center rounded-lg border bg-fd-card p-8 text-sm text-fd-muted-foreground">
+        Loading diagram...
+      </div>
+    );
+  }
+
+  return (
+    <div
+      ref={containerRef}
+      className="my-4 flex justify-center overflow-x-auto rounded-lg border bg-fd-card p-4 [&_svg]:max-w-full"
+      dangerouslySetInnerHTML={{ __html: svg }}
+    />
+  );
+}

package/dist/site-template/content/docs/index.mdx

@@ -0,0 +1,10 @@
+---
+title: Welcome
+description: Auto-generated documentation
+---
+
+# Welcome
+
+This documentation was auto-generated by [open-auto-doc](https://github.com/open-auto-doc).
+
+Browse the sidebar to explore the documentation.

package/dist/site-template/content/docs/meta.json

@@ -0,0 +1,3 @@
+{
+  "pages": ["index"]
+}

package/dist/site-template/lib/layout.shared.ts

@@ -0,0 +1,9 @@
+import type { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
+
+export function baseOptions(): BaseLayoutProps {
+  return {
+    nav: {
+      title: "{{projectName}}",
+    },
+  };
+}

package/dist/site-template/lib/remark-mermaid.ts

@@ -0,0 +1,33 @@
+/**
+ * Remark plugin that transforms ```mermaid code blocks into <Mermaid /> JSX components.
+ * This runs before Shiki so the mermaid blocks never get syntax-highlighted as code.
+ */
+export function remarkMermaid() {
+  return (tree: any) => {
+    walk(tree);
+  };
+}
+
+function walk(node: any) {
+  if (!node.children) return;
+  for (let i = 0; i < node.children.length; i++) {
+    const child = node.children[i];
+    if (child.type === "code" && child.lang === "mermaid") {
+      node.children[i] = {
+        type: "mdxJsxFlowElement",
+        name: "Mermaid",
+        attributes: [
+          {
+            type: "mdxJsxAttribute",
+            name: "code",
+            value: child.value,
+          },
+        ],
+        children: [],
+        data: { _mdxExplicitJsx: true },
+      };
+    } else {
+      walk(child);
+    }
+  }
+}

package/dist/site-template/lib/source.ts

@@ -0,0 +1,7 @@
+import { docs } from "fumadocs-mdx:collections/server";
+import { loader } from "fumadocs-core/source";
+
+export const source = loader({
+  baseUrl: "/docs",
+  source: docs.toFumadocsSource(),
+});

package/dist/site-template/mdx-components.tsx

@@ -0,0 +1,11 @@
+import defaultMdxComponents from "fumadocs-ui/mdx";
+import type { MDXComponents } from "mdx/types";
+import { Mermaid } from "@/components/mermaid";
+
+export function getMDXComponents(components?: MDXComponents): MDXComponents {
+  return {
+    ...defaultMdxComponents,
+    Mermaid,
+    ...components,
+  };
+}

package/dist/site-template/next.config.mjs

@@ -0,0 +1,10 @@
+import { createMDX } from "fumadocs-mdx/next";
+
+const withMDX = createMDX();
+
+/** @type {import('next').NextConfig} */
+const config = {
+  reactStrictMode: true,
+};
+
+export default withMDX(config);

package/dist/site-template/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "{{projectName}}-docs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "postinstall": "fumadocs-mdx"
+  },
+  "dependencies": {
+    "next": "^16.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "fumadocs-core": "^16.0.0",
+    "fumadocs-ui": "^16.0.0",
+    "fumadocs-mdx": "^14.0.0",
+    "mermaid": "^11.0.0",
+    "lucide-react": "^0.475.0",
+    "@types/mdx": "^2.0.13"
+  },
+  "devDependencies": {
+    "@tailwindcss/postcss": "^4.0.0",
+    "@types/node": "^22.12.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "postcss": "^8.5.0",
+    "tailwindcss": "^4.0.0",
+    "typescript": "^5.7.0"
+  }
+}

package/dist/site-template/postcss.config.mjs

@@ -0,0 +1,7 @@
+const config = {
+  plugins: {
+    "@tailwindcss/postcss": {},
+  },
+};
+
+export default config;

package/dist/site-template/source.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig, defineDocs } from "fumadocs-mdx/config";
+import { remarkMermaid } from "./lib/remark-mermaid";
+
+export const docs = defineDocs({
+  dir: "content/docs",
+});
+
+export default defineConfig({
+  mdxOptions: {
+    remarkPlugins: [remarkMermaid],
+  },
+});

package/dist/site-template/tsconfig.json

@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "target": "ESNext",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "incremental": true,
+    "paths": {
+      "@/*": ["./*"],
+      "fumadocs-mdx:collections/*": [".source/*"]
+    },
+    "plugins": [{ "name": "next" }]
+  },
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    ".next/dev/types/**/*.ts"
+  ],
+  "exclude": ["node_modules"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@latent-space-labs/open-auto-doc",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Auto-generate beautiful documentation websites from GitHub repositories using AI",
   "type": "module",
   "bin": {