Merge pull request #51 from IntersectMBO/docs/comprehensive-architecture-documentation

docs: Add comprehensive architecture documentation

Author: solidsnakedev

docs/app/global.css

@@ -1,3 +1,4 @@
 @import 'tailwindcss';
 @import 'fumadocs-ui/css/neutral.css';
 @import 'fumadocs-ui/css/preset.css';
+@import 'fumadocs-twoslash/twoslash.css';

docs/app/layout.tsx

@@ -1,4 +1,5 @@
 import "@/app/global.css"
+import "@/app/twoslash.css"
 // import { RootProvider } from "fumadocs-ui/provider"
 import { Provider } from "./provider"
 

docs/app/twoslash.css

@@ -0,0 +1,2 @@
+/* Twoslash type hover styles */
+@import '@shikijs/twoslash/style-rich.css';

docs/components/mdx/mermaid.tsx

@@ -0,0 +1,59 @@
+'use client';
+import { use, useEffect, useId, useState } from 'react';
+import { useTheme } from 'next-themes';
+
+export function Mermaid({ chart }: { chart: string }) {
+  const [mounted, setMounted] = useState(false);
+  useEffect(() => {
+    setMounted(true);
+  }, []);
+
+  if (!mounted) return;
+
+  return <MermaidContent chart={chart} />;
+}
+
+const cache = new Map<string, Promise<unknown>>();
+
+function cachePromise<T>(
+  key: string,
+  setPromise: () => Promise<T>,
+): Promise<T> {
+  const cached = cache.get(key);
+  if (cached) return cached as Promise<T>;
+
+  const promise = setPromise();
+  cache.set(key, promise);
+  return promise;
+}
+
+function MermaidContent({ chart }: { chart: string }) {
+  const id = useId();
+  const { resolvedTheme } = useTheme();
+  const { default: mermaid } = use(
+    cachePromise('mermaid', () => import('mermaid')),
+  );
+
+  mermaid.initialize({
+    startOnLoad: false,
+    securityLevel: 'loose',
+    fontFamily: 'inherit',
+    themeCSS: 'margin: 1.5rem auto 0;',
+    theme: resolvedTheme === 'dark' ? 'dark' : 'default',
+  });
+
+  const { svg, bindFunctions } = use(
+    cachePromise(`${chart}-${resolvedTheme}`, () => {
+      return mermaid.render(id, chart.replaceAll('\\n', '\n'));
+    }),
+  );
+
+  return (
+    <div
+      ref={(container) => {
+        if (container) bindFunctions?.(container);
+      }}
+      dangerouslySetInnerHTML={{ __html: svg }}
+    />
+  );
+}

docs/components/search.tsx

@@ -14,8 +14,8 @@ import { useDocsSearch } from "fumadocs-core/search/client"
 import { create } from "@orama/orama"
 import { useI18n } from "fumadocs-ui/contexts/i18n"
 
-function initOrama() {
-  return create({
+async function initOrama() {
+  return await create({
     schema: { _: "string" },
     // https://docs.orama.com/docs/orama-js/supported-languages
     language: "english"
@@ -34,6 +34,7 @@ export default function DefaultSearchDialog(props: SharedProps) {
 
   const { search, setSearch, query } = useDocsSearch({
     type: "static",
+    // @ts-ignore - Orama type mismatch with fumadocs-core
     initOrama,
     locale,
     from: apiFrom

docs/content/docs/addresses/construction.mdx

@@ -0,0 +1,8 @@
+---
+title: Address Construction
+description: How to build Cardano addresses from keys and credentials
+---
+
+# Address Construction
+
+Content coming soon.

docs/content/docs/addresses/conversion.mdx

@@ -0,0 +1,8 @@
+---
+title: Address Conversion
+description: Convert between different address formats
+---
+
+# Address Conversion
+
+Content coming soon.

docs/content/docs/addresses/index.mdx

@@ -0,0 +1,8 @@
+---
+title: Addresses
+description: Working with Cardano addresses in Evolution SDK
+---
+
+# Addresses
+
+Content coming soon.

docs/content/docs/addresses/meta.json

@@ -0,0 +1,10 @@
+{
+  "title": "Addresses",
+  "pages": [
+    "index",
+    "construction",
+    "conversion",
+    "types",
+    "validation"
+  ]
+}

docs/content/docs/addresses/types.mdx

@@ -0,0 +1,8 @@
+---
+title: Address Types
+description: Different types of Cardano addresses and their uses
+---
+
+# Address Types
+
+Content coming soon.