@heyo-sh/create-heyo-docs 0.2.3 → 0.4.0

package/templates/react-router/content/openapi.json

@@ -0,0 +1,278 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Planet API",
+    "version": "1.0.0",
+    "description": "An example API used by the Heyo Docs React Router demo."
+  },
+  "servers": [
+    {
+      "url": "https://api.example.com/v1",
+      "description": "Example production API"
+    }
+  ],
+  "security": [
+    {
+      "BearerAuth": []
+    }
+  ],
+  "paths": {
+    "/organizations/{organizationId}/planets": {
+      "parameters": [
+        {
+          "name": "organizationId",
+          "in": "path",
+          "required": true,
+          "description": "The organization that owns the planets.",
+          "schema": {
+            "type": "string",
+            "example": "org_123"
+          }
+        }
+      ],
+      "get": {
+        "operationId": "listPlanets",
+        "summary": "List planets",
+        "description": "Returns the planets that belong to an organization.",
+        "tags": ["Planets"],
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Maximum number of records to return.",
+            "schema": {
+              "type": "integer",
+              "default": 20
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A page of planets.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Planet"
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "createPlanet",
+        "summary": "Create a planet",
+        "description": "Creates a planet inside an organization.",
+        "tags": ["Planets"],
+        "requestBody": {
+          "required": true,
+          "description": "The planet to create.",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PlanetInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "The newly created planet.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Planet"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/organizations/{organizationId}/planets/{planetId}": {
+      "parameters": [
+        {
+          "name": "organizationId",
+          "in": "path",
+          "required": true,
+          "description": "The organization that owns the planet.",
+          "schema": {
+            "type": "string",
+            "example": "org_123"
+          }
+        },
+        {
+          "name": "planetId",
+          "in": "path",
+          "required": true,
+          "description": "The planet identifier.",
+          "schema": {
+            "type": "string",
+            "example": "planet_earth"
+          }
+        }
+      ],
+      "get": {
+        "operationId": "getPlanet",
+        "summary": "Get a planet",
+        "description": "Returns one planet by ID.",
+        "tags": ["Planets"],
+        "responses": {
+          "200": {
+            "description": "The requested planet.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Planet"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Planet not found."
+          }
+        }
+      },
+      "put": {
+        "operationId": "replacePlanet",
+        "summary": "Replace a planet",
+        "description": "Replaces all editable planet values.",
+        "tags": ["Planets"],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PlanetInput"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The updated planet.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Planet"
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "operationId": "updatePlanet",
+        "summary": "Update a planet",
+        "description": "Updates one or more planet fields.",
+        "tags": ["Planets"],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PlanetPatch"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The updated planet.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Planet"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deletePlanet",
+        "summary": "Delete a planet",
+        "description": "Permanently removes a planet from an organization.",
+        "tags": ["Planets"],
+        "parameters": [
+          {
+            "name": "hardDelete",
+            "in": "query",
+            "description": "Also remove historical records.",
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Planet deleted."
+          },
+          "404": {
+            "description": "Planet not found."
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "BearerAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    },
+    "schemas": {
+      "Planet": {
+        "type": "object",
+        "required": ["id", "name", "classification"],
+        "properties": {
+          "id": {
+            "type": "string",
+            "example": "planet_earth"
+          },
+          "name": {
+            "type": "string",
+            "example": "Earth"
+          },
+          "classification": {
+            "type": "string",
+            "enum": ["terrestrial", "gas-giant", "ice-giant"]
+          }
+        }
+      },
+      "PlanetInput": {
+        "type": "object",
+        "required": ["name", "classification"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "example": "Mars"
+          },
+          "classification": {
+            "type": "string",
+            "enum": ["terrestrial", "gas-giant", "ice-giant"]
+          }
+        }
+      },
+      "PlanetPatch": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "example": "New Mars"
+          },
+          "classification": {
+            "type": "string",
+            "enum": ["terrestrial", "gas-giant", "ice-giant"]
+          }
+        }
+      }
+    }
+  }
+}

package/templates/react-router/heyo-docs.config.ts

@@ -11,15 +11,6 @@ export default heyoDocs({
       group: "Documentation",
       icon: "globe",
       sections: [
-        {
-          pages: [
-            {
-              title: "Documentation",
-              src: "https://docs.heyo.sh/introduction",
-              icon: "book",
-            },
-          ],
-        },
         {
           section: "Get Started",
           icon: "lightbulb",
@@ -39,8 +30,27 @@ export default heyoDocs({
         },
       ],
     },
+    {
+      group: "OpenAPI",
+      icon: "code",
+      sections: [
+        {
+          pages: ["api-overview"],
+        },
+        {
+          schema: "./openapi.json",
+        },
+      ],
+    },
+    {
+      group: "Changelog",
+      description: "Mock release notes for the Heyo Docs demo.",
+      icon: "changelog",
+      type: "changelog",
+      updates: ["changelog"],
+    },
   ],
-  branding: { name: "{{PROJECT_NAME}}" },
+  branding: { name: "{{PROJECT_NAME}}", logo: "/logo.svg" },
   // Set this before deploying to publish canonical and absolute social URLs.
   // siteUrl: "https://docs.example.com",
 });

package/templates/astro/content/index.mdx

@@ -1,22 +0,0 @@
----
-title: Welcome to {{PROJECT_NAME}}
-description: Everything you need to document your product with Heyo Docs.
----
-
-# Welcome to {{PROJECT_NAME}}
-
-Start with this page, then add focused MDX files to the `content` directory. Heyo Docs turns the directory structure into routes; use `groups` in `heyo-docs.config.ts` to control sidebar navigation and its order.
-
-## What is included?
-
-- An Astro application with a hydrated React documentation experience.
-- The selected documentation theme from `heyo-docs`.
-- Searchable page metadata, SEO tags, a sitemap, LLM endpoints, and a 404 page.
-
-## Edit this page
-
-```mdx
-## A new section
-
-Content updates reload in development.
-```

package/templates/next/content/index.mdx

@@ -1,22 +0,0 @@
----
-title: Welcome to {{PROJECT_NAME}}
-description: Everything you need to document your product with Heyo Docs.
----
-
-# Welcome to {{PROJECT_NAME}}
-
-Start with this page, then add focused MDX files to the `content` directory. Heyo Docs turns the directory structure into routes; use `groups` in `heyo-docs.config.ts` to control sidebar navigation and its order.
-
-## What is included?
-
-- A Next.js App Router application.
-- The selected documentation theme from `heyo-docs`.
-- Searchable page metadata, SEO tags, `robots.txt`, a sitemap, RSS, LLM files, Markdown mirrors, and a 404 page.
-
-## Edit this page
-
-```mdx
-## A new section
-
-Content updates reload in development.
-```

package/templates/react-router/content/index.mdx

@@ -1,22 +0,0 @@
----
-title: Welcome to {{PROJECT_NAME}}
-description: Everything you need to document your product with Heyo Docs.
----
-
-# Welcome to {{PROJECT_NAME}}
-
-Start with this page, then add focused MDX files to the `content` directory. Heyo Docs turns the directory structure into routes; use `groups` in `heyo-docs.config.ts` to control sidebar navigation and its order.
-
-## What is included?
-
-- A React Router Framework Mode application.
-- The Grain documentation theme from `heyo-docs`.
-- Searchable page metadata, SEO tags, a sitemap, and a 404 page.
-
-## Edit this page
-
-```mdx
-## A new section
-
-Content updates reload in development.
-```