@brainfish-ai/devdoc 0.1.41 → 0.1.43

package/ai-agents/schemas/docs.schema.json

@@ -0,0 +1,332 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://devdoc.sh/docs.json",
+  "title": "DevDoc Configuration Schema",
+  "description": "Schema for docs.json - the main configuration file for DevDoc documentation",
+  "type": "object",
+  "required": ["name", "navigation"],
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "Schema reference URL",
+      "default": "https://devdoc.sh/docs.json"
+    },
+    "name": {
+      "type": "string",
+      "description": "Documentation site name",
+      "examples": ["My Documentation", "Acme API Docs"]
+    },
+    "docType": {
+      "type": "string",
+      "enum": ["internal", "api", "product"],
+      "description": "Documentation type for AI agents",
+      "enumDescriptions": {
+        "internal": "Team docs: setup guides, architecture, contributing",
+        "api": "External developer docs: API reference, authentication, SDKs",
+        "product": "End user docs: features, tutorials, FAQs"
+      }
+    },
+    "favicon": {
+      "type": "string",
+      "description": "Path to favicon file",
+      "examples": ["/favicon.svg", "/assets/favicon.ico"]
+    },
+    "notice": {
+      "type": "object",
+      "description": "Announcement banner at top of docs",
+      "properties": {
+        "content": {
+          "type": "string",
+          "description": "Banner content (supports markdown links)",
+          "examples": ["🚀 We just launched v2.0! [Check it out](/changelog)"]
+        },
+        "dismissible": {
+          "type": "boolean",
+          "description": "Whether users can dismiss the banner",
+          "default": true
+        }
+      },
+      "required": ["content"]
+    },
+    "navigation": {
+      "type": "object",
+      "description": "Navigation structure",
+      "required": ["tabs"],
+      "properties": {
+        "tabs": {
+          "type": "array",
+          "description": "Top-level navigation tabs",
+          "items": {
+            "$ref": "#/definitions/tab"
+          }
+        },
+        "global": {
+          "type": "object",
+          "description": "Global navigation elements",
+          "properties": {
+            "anchors": {
+              "type": "array",
+              "description": "External links in header",
+              "items": {
+                "$ref": "#/definitions/anchor"
+              }
+            }
+          }
+        }
+      }
+    },
+    "navbar": {
+      "type": "object",
+      "description": "Navbar configuration",
+      "properties": {
+        "primary": {
+          "type": "object",
+          "description": "Primary CTA button",
+          "properties": {
+            "label": { "type": "string" },
+            "href": { "type": "string" }
+          },
+          "required": ["label", "href"]
+        }
+      }
+    },
+    "openapi": {
+      "type": "string",
+      "description": "Path to OpenAPI spec file",
+      "examples": ["api-reference/openapi.json", "api-reference/openapi.yaml"]
+    },
+    "api": {
+      "type": "object",
+      "description": "API configuration",
+      "properties": {
+        "baseUrl": {
+          "type": "string",
+          "description": "Base URL for API requests",
+          "examples": ["https://api.example.com"]
+        },
+        "playground": {
+          "type": "object",
+          "properties": {
+            "mode": {
+              "type": "string",
+              "enum": ["show", "hide"],
+              "default": "show"
+            }
+          }
+        }
+      }
+    },
+    "seo": {
+      "type": "object",
+      "description": "SEO settings",
+      "properties": {
+        "indexing": {
+          "type": "string",
+          "enum": ["navigation", "all", "none"],
+          "default": "navigation"
+        },
+        "metatags": {
+          "type": "object",
+          "description": "Custom meta tags",
+          "additionalProperties": { "type": "string" }
+        }
+      }
+    },
+    "redirects": {
+      "type": "array",
+      "description": "URL redirects",
+      "items": {
+        "type": "object",
+        "required": ["source", "destination"],
+        "properties": {
+          "source": {
+            "type": "string",
+            "description": "Source path (supports wildcards)",
+            "examples": ["/old-page", "/docs/:slug*"]
+          },
+          "destination": {
+            "type": "string",
+            "description": "Destination path",
+            "examples": ["/new-page", "/:slug*"]
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "tab": {
+      "type": "object",
+      "required": ["tab"],
+      "properties": {
+        "tab": {
+          "type": "string",
+          "description": "Tab display name",
+          "examples": ["Guides", "API Reference", "Changelog"]
+        },
+        "type": {
+          "type": "string",
+          "enum": ["docs", "openapi", "graphql", "changelog"],
+          "default": "docs",
+          "description": "Tab type"
+        },
+        "path": {
+          "type": "string",
+          "description": "URL path prefix for this tab",
+          "examples": ["/api-reference", "/changelog"]
+        },
+        "groups": {
+          "type": "array",
+          "description": "Navigation groups within this tab",
+          "items": {
+            "$ref": "#/definitions/group"
+          }
+        },
+        "versions": {
+          "type": "array",
+          "description": "API versions (for openapi type)",
+          "items": {
+            "type": "object",
+            "required": ["version", "spec"],
+            "properties": {
+              "version": { "type": "string" },
+              "spec": { "type": "string" },
+              "default": { "type": "boolean" }
+            }
+          }
+        },
+        "spec": {
+          "type": "string",
+          "description": "OpenAPI spec path (shorthand for single version)"
+        },
+        "schema": {
+          "type": "string",
+          "description": "GraphQL schema path (for graphql type)"
+        },
+        "endpoint": {
+          "type": "string",
+          "description": "GraphQL endpoint URL (for graphql type)"
+        }
+      }
+    },
+    "group": {
+      "type": "object",
+      "required": ["group", "pages"],
+      "properties": {
+        "group": {
+          "type": "string",
+          "description": "Group display name",
+          "examples": ["Getting Started", "Configuration", "API Reference"]
+        },
+        "icon": {
+          "type": "string",
+          "description": "Phosphor icon name",
+          "examples": ["rocket-launch", "book-open", "code", "gear", "terminal", "puzzle-piece", "star", "shield", "user", "robot"]
+        },
+        "pages": {
+          "type": "array",
+          "description": "Pages in this group (file paths without .mdx extension, or nested groups)",
+          "items": {
+            "oneOf": [
+              {
+                "type": "string",
+                "description": "Page path (without .mdx extension)",
+                "examples": ["index", "quickstart", "guides/authentication"]
+              },
+              {
+                "$ref": "#/definitions/group"
+              }
+            ]
+          }
+        }
+      }
+    },
+    "anchor": {
+      "type": "object",
+      "required": ["anchor", "href"],
+      "properties": {
+        "anchor": {
+          "type": "string",
+          "description": "Link display text",
+          "examples": ["GitHub", "Discord", "Twitter"]
+        },
+        "href": {
+          "type": "string",
+          "description": "Link URL"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Phosphor icon name",
+          "examples": ["github-logo", "discord-logo", "twitter-logo"]
+        }
+      }
+    }
+  },
+  "examples": [
+    {
+      "$schema": "https://devdoc.sh/docs.json",
+      "name": "Acme Documentation",
+      "docType": "api",
+      "favicon": "/favicon.svg",
+      "navigation": {
+        "tabs": [
+          {
+            "tab": "Guides",
+            "type": "docs",
+            "groups": [
+              {
+                "group": "Getting Started",
+                "icon": "rocket-launch",
+                "pages": ["index", "quickstart", "authentication"]
+              },
+              {
+                "group": "Features",
+                "icon": "star",
+                "pages": ["features/overview", "features/advanced"]
+              }
+            ]
+          },
+          {
+            "tab": "API Reference",
+            "type": "openapi",
+            "path": "/api-reference",
+            "versions": [
+              { "version": "v2", "spec": "api-reference/v2/openapi.json", "default": true },
+              { "version": "v1", "spec": "api-reference/v1/openapi.json" }
+            ],
+            "groups": [
+              {
+                "group": "Overview",
+                "icon": "book-open",
+                "pages": ["api-reference/introduction"]
+              }
+            ]
+          },
+          {
+            "tab": "Changelog",
+            "type": "changelog",
+            "path": "/changelog"
+          }
+        ],
+        "global": {
+          "anchors": [
+            {
+              "anchor": "GitHub",
+              "href": "https://github.com/acme/docs",
+              "icon": "github-logo"
+            }
+          ]
+        }
+      },
+      "openapi": "api-reference/openapi.json",
+      "api": {
+        "baseUrl": "https://api.acme.com",
+        "playground": {
+          "mode": "show"
+        }
+      },
+      "seo": {
+        "indexing": "navigation"
+      }
+    }
+  ]
+}

package/ai-agents/schemas/theme.schema.json

@@ -0,0 +1,243 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://devdoc.sh/theme.json",
+  "title": "DevDoc Theme Schema",
+  "description": "Schema for theme.json - customize the look and feel of your documentation",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "Schema reference URL",
+      "default": "https://devdoc.sh/theme.json"
+    },
+    "logo": {
+      "type": "object",
+      "description": "Logo configuration",
+      "properties": {
+        "url": {
+          "type": "string",
+          "description": "Single logo URL for both light and dark modes",
+          "examples": ["/assets/logo.svg"]
+        },
+        "light": {
+          "type": "string",
+          "description": "Logo for light mode",
+          "examples": ["/assets/logo/light.svg", "/logo-light.svg"]
+        },
+        "dark": {
+          "type": "string",
+          "description": "Logo for dark mode",
+          "examples": ["/assets/logo/dark.svg", "/logo-dark.svg"]
+        },
+        "alt": {
+          "type": "string",
+          "description": "Alt text for accessibility",
+          "examples": ["Acme Documentation", "My Project"]
+        },
+        "width": {
+          "type": "number",
+          "description": "Logo width in pixels",
+          "default": 120,
+          "examples": [100, 120, 150, 180]
+        },
+        "height": {
+          "type": "number",
+          "description": "Logo height in pixels",
+          "default": 32,
+          "examples": [24, 32, 40]
+        }
+      }
+    },
+    "colors": {
+      "type": "object",
+      "description": "Brand colors (use hex codes)",
+      "properties": {
+        "primary": {
+          "type": "string",
+          "description": "Primary brand color for links, buttons, accents",
+          "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
+          "examples": ["#6366f1", "#3b82f6", "#10b981", "#f59e0b", "#ef4444"]
+        },
+        "primaryLight": {
+          "type": "string",
+          "description": "Lighter variant for hover states",
+          "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
+          "examples": ["#818cf8", "#60a5fa", "#34d399"]
+        },
+        "primaryDark": {
+          "type": "string",
+          "description": "Darker variant for dark mode accents",
+          "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$",
+          "examples": ["#4f46e5", "#2563eb", "#059669"]
+        }
+      }
+    },
+    "header": {
+      "type": "object",
+      "description": "Header configuration",
+      "properties": {
+        "showAskAI": {
+          "type": "boolean",
+          "description": "Show AI assistant button",
+          "default": true
+        },
+        "showSearch": {
+          "type": "boolean",
+          "description": "Show search bar",
+          "default": true
+        },
+        "showThemeToggle": {
+          "type": "boolean",
+          "description": "Show dark/light mode toggle",
+          "default": true
+        }
+      }
+    },
+    "navbar": {
+      "type": "object",
+      "description": "Navbar links and CTA",
+      "properties": {
+        "links": {
+          "type": "array",
+          "description": "Header navigation links",
+          "items": {
+            "type": "object",
+            "required": ["label", "href"],
+            "properties": {
+              "label": {
+                "type": "string",
+                "description": "Link text",
+                "examples": ["Blog", "Dashboard", "GitHub"]
+              },
+              "href": {
+                "type": "string",
+                "description": "Link URL"
+              },
+              "external": {
+                "type": "boolean",
+                "description": "Opens in new tab if true",
+                "default": false
+              }
+            }
+          }
+        },
+        "primary": {
+          "type": "object",
+          "description": "Primary CTA button in header",
+          "required": ["label", "href"],
+          "properties": {
+            "label": {
+              "type": "string",
+              "description": "Button text",
+              "examples": ["Get Started", "Sign Up", "Try Free"]
+            },
+            "href": {
+              "type": "string",
+              "description": "Button link URL",
+              "examples": ["/quickstart", "https://app.example.com/signup"]
+            }
+          }
+        }
+      }
+    },
+    "typography": {
+      "type": "object",
+      "description": "Typography settings",
+      "properties": {
+        "fontFamily": {
+          "type": "string",
+          "description": "Main font family",
+          "examples": ["Inter, sans-serif", "'Geist', -apple-system, sans-serif"]
+        },
+        "fontFamilyMono": {
+          "type": "string",
+          "description": "Monospace font for code",
+          "examples": ["'JetBrains Mono', 'Fira Code', monospace", "'SF Mono', Consolas, monospace"]
+        },
+        "baseFontSize": {
+          "type": "string",
+          "description": "Base font size",
+          "default": "16px",
+          "examples": ["14px", "15px", "16px"]
+        }
+      }
+    },
+    "defaultTheme": {
+      "type": "string",
+      "enum": ["light", "dark", "system"],
+      "description": "Default color theme",
+      "default": "system"
+    },
+    "customCss": {
+      "type": "string",
+      "description": "Path to custom CSS file",
+      "examples": ["custom.css", "styles/custom.css"]
+    }
+  },
+  "examples": [
+    {
+      "$schema": "https://devdoc.sh/theme.json",
+      "logo": {
+        "light": "/assets/logo/light.svg",
+        "dark": "/assets/logo/dark.svg",
+        "alt": "Acme Documentation",
+        "width": 120,
+        "height": 32
+      },
+      "colors": {
+        "primary": "#6366f1",
+        "primaryLight": "#818cf8",
+        "primaryDark": "#4f46e5"
+      },
+      "header": {
+        "showAskAI": true,
+        "showSearch": true,
+        "showThemeToggle": true
+      },
+      "navbar": {
+        "links": [
+          {
+            "label": "Blog",
+            "href": "https://blog.acme.com",
+            "external": true
+          }
+        ],
+        "primary": {
+          "label": "Get Started",
+          "href": "/quickstart"
+        }
+      },
+      "defaultTheme": "system",
+      "customCss": "custom.css"
+    },
+    {
+      "$schema": "https://devdoc.sh/theme.json",
+      "logo": {
+        "url": "/logo.svg",
+        "alt": "My Project",
+        "width": 100
+      },
+      "colors": {
+        "primary": "#10b981"
+      },
+      "header": {
+        "showAskAI": true,
+        "showSearch": true,
+        "showThemeToggle": true
+      }
+    }
+  ],
+  "colorPresets": {
+    "description": "Common color presets for quick reference",
+    "presets": {
+      "indigo": { "primary": "#6366f1", "primaryLight": "#818cf8", "primaryDark": "#4f46e5" },
+      "blue": { "primary": "#3b82f6", "primaryLight": "#60a5fa", "primaryDark": "#2563eb" },
+      "green": { "primary": "#10b981", "primaryLight": "#34d399", "primaryDark": "#059669" },
+      "amber": { "primary": "#f59e0b", "primaryLight": "#fbbf24", "primaryDark": "#d97706" },
+      "red": { "primary": "#ef4444", "primaryLight": "#f87171", "primaryDark": "#dc2626" },
+      "purple": { "primary": "#8b5cf6", "primaryLight": "#a78bfa", "primaryDark": "#7c3aed" },
+      "pink": { "primary": "#ec4899", "primaryLight": "#f472b6", "primaryDark": "#db2777" },
+      "slate": { "primary": "#64748b", "primaryLight": "#94a3b8", "primaryDark": "#475569" }
+    }
+  }
+}