docs: add tty docs section with API reference (#60)

* docs: add tty docs section with API reference

* docs: expand API documentation with architecture details and input module explanation

---------

Signed-off-by: paul valladares <85648028+dreyfus92@users.noreply.github.com>

Author: dreyfus92

astro.config.mjs

@@ -4,6 +4,10 @@ import starlight from "@astrojs/starlight";
 import ecTwoSlash from "expressive-code-twoslash";
 import topics from "starlight-sidebar-topics";
 import starlightMarkdown from "starlight-markdown";
+import mermaid from "astro-mermaid";
+import { fileURLToPath } from "node:url";
+
+const docsRoot = fileURLToPath(new URL(".", import.meta.url));
 
 const site = "https://bomb.sh/docs/";
 
@@ -21,6 +25,7 @@ export default defineConfig({
 		}
 	},
 	integrations: [
+		mermaid({ autoTheme: true }),
 		starlight({
 			title: "Bombshell",
 			logo: {
@@ -40,7 +45,18 @@ export default defineConfig({
 						cursorColor: 'rgba(255 0 210)'
 					}
 				},
-				plugins: [ecTwoSlash()],
+				plugins: [ecTwoSlash({
+					twoslashOptions: {
+						compilerOptions: {
+							module: 99,
+							moduleResolution: 100,
+							baseUrl: docsRoot,
+							paths: {
+								"@bomb.sh/tty": ["node_modules/@bomb.sh/tty/esm/mod.d.ts"],
+							},
+						},
+					},
+				})],
 			},
 			editLink: {
 				baseUrl: "https://github.com/bombshell-dev/docs/edit/main/",
@@ -124,6 +140,27 @@ export default defineConfig({
 						link: "/tab/",
 						items: [],
 					},
+					{
+						label: "TTY",
+						id: "tty",
+						icon: "seti:config",
+						link: "/tty/basics/getting-started",
+						items: [
+							{ label: "Basics", autogenerate: { directory: "tty/basics" } },
+							{ label: "Guides", autogenerate: { directory: "tty/guides" } },
+							{
+								label: "API",
+								items: [
+									{ label: "Overview", link: "/tty/api/" },
+									{ label: "Ops", link: "/tty/api/ops" },
+									{ label: "Term", link: "/tty/api/term" },
+									{ label: "Input", link: "/tty/api/input" },
+									{ label: "Settings", link: "/tty/api/settings" },
+									{ label: "Termcodes", link: "/tty/api/termcodes" },
+								],
+							},
+						],
+					},
 				]),
 			],
 		}),

package.json

@@ -16,6 +16,7 @@
   "dependencies": {
     "@astrojs/starlight": "^0.37.1",
     "@bomb.sh/args": "^0.3.1",
+    "@bomb.sh/tty": "^0.8.0",
     "@clack/core": "^1.4.3",
     "@clack/prompts": "^1.7.0",
     "@types/node": "^22.19.3",
@@ -26,7 +27,9 @@
     "@xterm/xterm": "^6.0.0",
     "arktype": "^2.2.0",
     "astro": "^5.16.6",
+    "astro-mermaid": "^2.1.0",
     "expressive-code-twoslash": "^0.5.3",
+    "mermaid": "^11.16.0",
     "sharp": "^0.33.5",
     "starlight-markdown": "^0.1.5",
     "starlight-sidebar-topics": "^0.6.2"