docs: generate API reference docs from TS packages (#41)

* docs: generate API reference docs from TS packages

* chore: rename App Kit to AppKit

* chore: mark some stuff as internal, rename Variables to Helpers

* chore: remove appkit-ui generated docs

* chore: flatten docs structure

Author: pkosiec

.github/workflows/ci.yml

@@ -31,6 +31,7 @@ jobs:
           filters: |
             docs:
               - 'docs/**'
+              - 'packages/**'
             appkit:
               - '!docs/**'
 
@@ -97,4 +98,23 @@ jobs:
         run: pnpm install --frozen-lockfile
       - name: Build Docs
         run: pnpm run docs:build
+      - name: Lint Generated Docs
+        run: pnpm run docs:lint
+      - name: Format Generated Docs
+        run: pnpm run docs:format
+      - name: Check for uncommitted docs changes
+        run: |
+          if ! git diff --exit-code docs/docs/api/; then
+            echo "❌ Error: Generated docs are out of sync with the codebase."
+            echo ""
+            echo "The API documentation in docs/docs/api/ has changes after running docs:generate."
+            echo "This means the committed docs don't match the current package code."
+            echo ""
+            echo "To fix this:"
+            echo "  1. Run: pnpm docs:build"
+            echo "  2. Run: pnpm docs:format"
+            echo "  3. Review and commit the changes"
+            echo ""
+            exit 1
+          fi
 

apps/clean-app/src/main.tsx

@@ -3,7 +3,12 @@ import { createRoot } from "react-dom/client";
 import "./index.css";
 import App from "./App.tsx";
 
-createRoot(document.getElementById("root")!).render(
+const rootElement = document.getElementById("root");
+if (!rootElement) {
+  throw new Error("Root element not found");
+}
+
+createRoot(rootElement).render(
   <StrictMode>
     <App />
   </StrictMode>,

biome.json

@@ -16,7 +16,8 @@
       "!**/coverage",
       "!packages/appkit-ui/src/react/ui",
       "!**/routeTree.gen.ts",
-      "!docs/.docusaurus"
+      "!docs/.docusaurus",
+      "!**/typedoc-sidebar.ts"
     ]
   },
   "formatter": {