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

package/templates/react-router/content/essentials/lists.mdx

@@ -1,40 +1,36 @@
 ---
 title: Lists
-description: Use ordered, unordered, and task lists to make steps and choices easy to scan.
+description: Use lists to make choices and short steps easy to scan.
 ---
 
 # Lists
 
-Lists make a page easier to scan when readers need to compare options, follow a
-short sequence, or check completion. Keep every item parallel in structure and
-start it with the action or noun that matters most.
+Use a list when readers need to scan choices or follow a short sequence.
 
-## Use bullets for related options
+## Add a bullet list
 
-Use an unordered list when order does not change the result.
+Use bullets when the order does not matter.
 
 - Keep MDX pages in the `content` directory.
 - Add important routes to `heyo-docs.config.ts`.
 - Build the project before publishing.
 
-## Use numbers when sequence matters
+## Add numbered steps
 
-An ordered list makes dependencies explicit.
+Use numbers when the order matters.
 
 1. Create an MDX file.
 2. Add its path to a sidebar section.
 3. Start the development server.
 4. Review the rendered route.
 
-## Keep nested lists intentional
+## Add one level when needed
 
-Use a nested list only to clarify a direct relationship. Too many levels make
-the page harder to scan than a short heading and paragraph.
+Use a nested list only for a direct relationship.
 
 - Prepare the release:
   - Review the changed pages.
   - Confirm navigation order.
   - Run the production build.
 
-Use a `Steps` component instead when each item needs rich content such as a
-command, callout, or additional explanation.
+Use `Steps` when each step needs a command or more explanation.

package/templates/react-router/content/essentials/tables.mdx

@@ -1,18 +1,13 @@
 ---
 title: Tables
-description: Compare a small, consistent set of options in a documentation table.
+description: Compare a small set of options with a simple Markdown table.
 ---
 
 # Tables
 
-Use a table when readers need to compare the same attributes across a small
-number of options. Tables are strongest when every cell is short and each row
-can be understood without a paragraph of surrounding prose.
+Use a table to compare the same details across a small number of options.
 
-## Compare like with like
-
-For example, a configuration reference can show the setting, its purpose, and
-a representative value.
+## Add a table
 
 | Setting   | Purpose                                | Example                      |
 | --------- | -------------------------------------- | ---------------------------- |
@@ -21,11 +16,10 @@ a representative value.
 | `mode`    | Initial color preference.              | `"system"`                   |
 | `siteUrl` | Canonical public site origin.          | `"https://docs.example.com"` |
 
-## Keep cells concise
+## Keep it readable
 
-Move long explanations, procedures, and code samples out of the table. Link to
-a focused guide instead of stretching a table past the point where it can be
-read horizontally.
+Use short headings and short cells. Put long explanations in a section below
+the table.
 
 | Use a table for        | Use a section for      |
 | ---------------------- | ---------------------- |
@@ -33,5 +27,4 @@ read horizontally.
 | Option defaults        | A detailed explanation |
 | Short reference values | A large code example   |
 
-If a reader must act on the information in a specific order, use a numbered
-list or [Quickstart](/quickstart) instead.
+Use a numbered list when readers must act in a specific order.

package/templates/react-router/content/essentials/tabs.mdx

@@ -1,18 +1,14 @@
 ---
 title: Tabs
-description: Let readers choose between related commands or platform-specific instructions.
+description: Let readers switch between equivalent commands or platforms.
 ---
 
 # Tabs
 
-`Tabs` presents related content one panel at a time. It is useful for package
-manager commands, framework variants, and small comparisons where readers need
-only one option to complete the task.
+Use tabs for equivalent ways to complete the same task. Keep their labels
+short.
 
-## Label equivalent choices clearly
-
-Each `Tab` needs a concise title. Give a tab a stable `value` when you need
-to set a different initial panel with `defaultValue`.
+## Add tabs
 
 <Tabs defaultValue="typescript" variant="line">
   <Tab title="JavaScript" value="javascript">
@@ -23,11 +19,9 @@ to set a different initial panel with `defaultValue`.
   </Tab>
 </Tabs>
 
-## Keep the choices parallel
+## Compare platforms
 
-Tabs work when every panel solves the same problem in a different environment.
-Use headings or `Steps` for a sequence that every reader must complete; tabs
-can hide required information.
+Each tab should answer the same question for a different platform.
 
 <Tabs defaultValue="vercel" variant="line">
   <Tab title="Vercel" value="vercel">
@@ -40,3 +34,7 @@ can hide required information.
     Upload the build output to any host that serves static files.
   </Tab>
 </Tabs>
+
+<Callout type="tip" title="Use tabs sparingly">
+  Use headings or <code>Steps</code> for information that every reader needs.
+</Callout>

package/templates/react-router/content/essentials/text-styling.mdx

@@ -1,19 +1,16 @@
 ---
 title: Text Styling
-description: Structure documentation with clear headings, emphasis, links, and quotes.
+description: Use simple Markdown for headings, emphasis, links, and quotes.
 ---
 
 # Text Styling
 
-Good documentation is easy to scan before it is read in detail. Use the
-frontmatter title for the page's H1, then organize the body around short,
-descriptive H2 and H3 headings.
+Use regular Markdown for most documentation. Keep the text short and let
+headings show readers where to look next.
 
-## Build a clear hierarchy
+## Add headings
 
-Use `##` for the main tasks or ideas on a page. Add `###` only when a section
-has a meaningful subdivision. Headings should tell the reader what they will
-learn, not simply announce that more information follows.
+Use `##` for a main section and `###` only for a useful subsection.
 
 ```md
 ## Configure navigation
@@ -22,29 +19,25 @@ Add pages in the order readers should follow.
 
 ### Add an external resource
 
-Use a custom link for a separate destination.
+Link to a resource outside your documentation.
 ```
 
-## Emphasize the decision
+## Highlight important text
 
-Use **bold text** for an important choice and inline `code` for literal values
-such as file names, commands, and configuration keys. Keep the rest of the
-sentence plain so these signals remain useful.
+Use **bold** for an important choice and inline `code` for values readers need
+to copy.
 
 ```md
 Set `content: "content"` in `heyo-docs.config.ts`.
 
-Deploy **after** reviewing the production build.
+Run `bun run build` before you publish.
 ```
 
-## Link with context
+## Write useful links
 
-Describe where a link goes instead of pasting a raw URL. Relative links work
-well for another page in the same documentation, while full URLs are useful for
-external resources.
+Use the destination as the link text. It is easier to scan than a raw URL.
 
-Read the [Quickstart](/quickstart) before changing the
+Read the [Quickstart](/quickstart) before changing
 [site configuration](/configuration).
 
-> Keep each paragraph focused on one idea so readers can quickly find the
-> decision that applies to them.
+> Keep one idea in each short paragraph.

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

@@ -0,0 +1,160 @@
+{
+  "openapi": "3.0.4",
+  "info": {
+    "title": "Swagger Petstore - OpenAPI 3.0",
+    "description": "A small, read-only extract of the public Swagger Petstore schema for debugging Heyo Docs. Source: https://petstore3.swagger.io/api/v3/openapi.json",
+    "version": "1.0.27",
+    "license": {
+      "name": "Apache 2.0",
+      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
+    }
+  },
+  "servers": [
+    {
+      "url": "https://petstore3.swagger.io/api/v3",
+      "description": "Swagger Petstore public server"
+    }
+  ],
+  "paths": {
+    "/pet/findByStatus": {
+      "get": {
+        "tags": ["pet"],
+        "summary": "Finds Pets by status.",
+        "description": "Multiple status values can be provided with comma separated strings.",
+        "operationId": "findPetsByStatus",
+        "parameters": [
+          {
+            "name": "status",
+            "in": "query",
+            "description": "Status values that need to be considered for filter",
+            "required": true,
+            "explode": true,
+            "schema": {
+              "type": "string",
+              "default": "available",
+              "enum": ["available", "pending", "sold"]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": { "$ref": "#/components/schemas/Pet" }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid status value"
+          },
+          "default": {
+            "description": "Unexpected error"
+          }
+        }
+      }
+    },
+    "/store/order/{orderId}": {
+      "get": {
+        "tags": ["store"],
+        "summary": "Find purchase order by ID.",
+        "description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.",
+        "operationId": "getOrderById",
+        "parameters": [
+          {
+            "name": "orderId",
+            "in": "path",
+            "description": "ID of order that needs to be fetched.",
+            "required": true,
+            "schema": {
+              "type": "integer",
+              "format": "int64"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/Order" }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid ID supplied"
+          },
+          "404": {
+            "description": "Order not found"
+          },
+          "default": {
+            "description": "Unexpected error"
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Order": {
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer", "format": "int64", "example": 10 },
+          "petId": {
+            "type": "integer",
+            "format": "int64",
+            "example": 198772
+          },
+          "quantity": { "type": "integer", "format": "int32", "example": 7 },
+          "shipDate": { "type": "string", "format": "date-time" },
+          "status": {
+            "type": "string",
+            "description": "Order Status",
+            "example": "approved",
+            "enum": ["placed", "approved", "delivered"]
+          },
+          "complete": { "type": "boolean" }
+        }
+      },
+      "Category": {
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer", "format": "int64", "example": 1 },
+          "name": { "type": "string", "example": "Dogs" }
+        }
+      },
+      "Tag": {
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer", "format": "int64" },
+          "name": { "type": "string" }
+        }
+      },
+      "Pet": {
+        "required": ["name", "photoUrls"],
+        "type": "object",
+        "properties": {
+          "id": { "type": "integer", "format": "int64", "example": 10 },
+          "name": { "type": "string", "example": "doggie" },
+          "category": { "$ref": "#/components/schemas/Category" },
+          "photoUrls": {
+            "type": "array",
+            "items": { "type": "string" }
+          },
+          "tags": {
+            "type": "array",
+            "items": { "$ref": "#/components/schemas/Tag" }
+          },
+          "status": {
+            "type": "string",
+            "description": "pet status in the store",
+            "enum": ["available", "pending", "sold"]
+          }
+        }
+      }
+    }
+  }
+}

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",
 });