@clidey/dory 0.21.4 → 0.22.0

package/dist/features.mdx

@@ -0,0 +1,440 @@
+---
+title: 'Features'
+description: 'Overview of available components and features'
+---
+
+## Headings Examples
+
+```mdx
+# Heading 1
+```
+# Heading 1
+
+```mdx
+## Heading 2
+```
+# Heading 2
+
+```mdx
+### Heading 3
+```
+# Heading 3
+```mdx
+#### Heading 4
+```
+# Heading 4
+```mdx
+##### Heading 5
+```
+# Heading 5
+```mdx
+###### Heading 6
+```
+# Heading 6
+
+<br />
+
+## Lists Examples
+
+```mdx
+- List item 1
+- List item 2
+- List item 3
+```
+
+- List item 1
+- List item 2
+- List item 3
+
+```mdx
+1. List item 1
+2. List item 2
+3. List item 3
+```
+
+1. List item 1
+2. List item 2
+3. List item 3
+
+
+
+<br />
+
+### Images
+
+```mdx
+<img src="./assets/dory.jpeg" alt="Example image" className="object-cover w-64 h-64" />
+```
+
+<img src="./assets/dory.jpeg" alt="Example image" className="object-cover w-64 h-64" />
+
+
+<br />
+<br />
+<br />
+
+## Code Components
+
+### Code Block
+```typescript
+function example() {
+  return "Hello World";
+}
+```
+
+### Code Group Block
+
+<CodeGroup>
+```typescript
+function example(): string {
+  return "Hello World";
+}
+```
+```javascript
+function example() {
+  return "Hello World";
+}
+```
+</CodeGroup>
+
+
+<br />
+<br />
+<br />
+
+
+## Interactive Components
+
+### Mermaid
+
+```mdx
+mermaid
+graph TD
+
+  %% Main Start
+  Start([Start Process]) --> Validate[Validate Input]
+
+  %% Decision Point
+  Validate -->|Valid| ProcessData{Is Data Clean?}
+  Validate -->|Invalid| Error[Show Error Message]
+
+  %% Clean Data Branch
+  ProcessData -->|Yes| Clean[Clean Data]
+  Clean --> Analyze[Analyze Data]
+
+  %% Dirty Data Branch
+  ProcessData -->|No| Notify[Notify User]
+  Notify --> Wait[Wait for Input]
+  Wait --> Validate
+
+  %% Parallel Branches After Analysis
+  Analyze --> Split1 & Split2
+
+  subgraph Parallel Tasks
+    Split1[Generate Report] --> Merge
+    Split2[Update Dashboard] --> Merge
+  end
+
+  Merge --> Decision2{Is More Input Needed?}
+  Decision2 -->|Yes| WaitMore[Wait for More Input]
+  WaitMore --> Validate
+  Decision2 -->|No| End([End Process])
+
+  %% Style and Class Definitions
+  classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
+  class ProcessData,Decision2 decision;
+
+```
+
+<strong>
+<p>Note: Mermaid should be inside a code block with type "mermaid"</p>
+</strong>
+
+```mermaid
+graph TD
+
+  %% Main Start
+  Start([Start Process]) --> Validate[Validate Input]
+
+  %% Decision Point
+  Validate -->|Valid| ProcessData{Is Data Clean?}
+  Validate -->|Invalid| Error[Show Error Message]
+
+  %% Clean Data Branch
+  ProcessData -->|Yes| Clean[Clean Data]
+  Clean --> Analyze[Analyze Data]
+
+  %% Dirty Data Branch
+  ProcessData -->|No| Notify[Notify User]
+  Notify --> Wait[Wait for Input]
+  Wait --> Validate
+
+  %% Parallel Branches After Analysis
+  Analyze --> Split1 & Split2
+
+  subgraph Parallel Tasks
+    Split1[Generate Report] --> Merge
+    Split2[Update Dashboard] --> Merge
+  end
+
+  Merge --> Decision2{Is More Input Needed?}
+  Decision2 -->|Yes| WaitMore[Wait for More Input]
+  WaitMore --> Validate
+  Decision2 -->|No| End([End Process])
+
+  %% Style and Class Definitions
+  classDef decision fill:#f9f,stroke:#333,stroke-width:2px;
+  class ProcessData,Decision2 decision;
+
+```
+
+### Accordion
+
+```mdx
+<AccordionGroup>
+  <Accordion title="First Section" icon="DocumentIcon">
+    This is the content of the first accordion section.
+  </Accordion>
+  <Accordion title="Second Section" icon="CodeBracketIcon">
+    This is the content of the second accordion section.
+  </Accordion>
+</AccordionGroup>
+```
+
+<AccordionGroup>
+  <Accordion title="First Section" icon="DocumentIcon">
+    This is the content of the first accordion section.
+  </Accordion>
+  <Accordion title="Second Section" icon="CodeBracketIcon">
+    This is the content of the second accordion section.
+  </Accordion>
+</AccordionGroup>
+
+### Callouts
+
+```mdx
+<Note>
+  This is a note callout with important information.
+</Note>
+```
+
+<Note>
+  This is a note callout with important information.
+</Note>
+
+```mdx
+<Warning>
+  This is a warning callout for critical information.
+</Warning>
+```
+
+<Warning>
+  This is a warning callout for critical information.
+</Warning>
+
+```mdx
+<Info>
+  This is an info callout for general information.
+</Info>
+```
+
+<Info>
+  This is an info callout for general information.
+</Info>
+
+```mdx
+<Tip>
+  This is a tip callout for helpful suggestions.
+</Tip>
+```
+
+<Tip>
+  This is a tip callout for helpful suggestions.
+</Tip>
+
+```mdx
+<Check>
+  This is a check callout for completed items.
+</Check>
+```
+
+<Check>
+  This is a check callout for completed items.
+</Check>
+
+
+<br />
+
+### Cards
+```mdx
+<CardGroup cols={2}>
+  <Card 
+    title="Example Card" 
+    description="This is an example card component with an icon and title."
+    icon="FileText"
+    href="#"
+  />
+  <Card 
+    title="Another Card" 
+    description="This is another example card with different content."
+    icon="Code"
+    href="#"
+  />
+</CardGroup>
+```
+
+<CardGroup cols={2}>
+  <Card 
+    title="Example Card" 
+    description="This is an example card component with an icon and title."
+    icon="FileText"
+    href="#"
+  />
+  <Card 
+    title="Another Card" 
+    description="This is another example card with different content."
+    icon="Code"
+    href="#"
+  />
+</CardGroup>
+
+<br />
+
+### Expandable
+
+```mdx
+<Expandable title="Click to Expand">
+  This is an expandable section that can be toggled.
+</Expandable>
+```
+
+<Expandable title="Click to Expand">
+  This is an expandable section that can be toggled.
+</Expandable>
+
+### Source
+
+```mdx
+<Source url="https://github.com/clidey/dory" paths={[
+  { path: "src/mdx/source.tsx", range: "1-46" },
+  { path: "docs/features.mdx", range: "318-322" },
+]} />
+```
+
+<Source url="https://github.com/clidey/dory" paths={[
+  { path: "src/mdx/source.tsx", range: "1-46" },
+  { path: "docs/features.mdx", range: "318-322" },
+]} />
+
+<br />
+<br />
+<br />
+
+
+## Special Components
+
+### Grids
+
+#### Rows
+```mdx
+<Row cols={2}>
+  <Icon icon="FileText" />
+  <Icon icon="CheckCircle" />
+</Row>
+```
+
+<Row cols={2}>
+  <Icon icon="FileText" />
+  <Icon icon="CheckCircle" />
+</Row>
+
+<br />
+
+#### Columns
+
+```mdx
+<Col>
+  <Icon icon="FileText" />
+  <Icon icon="FileText" />
+</Col>
+```
+
+<Col>
+  <Icon icon="FileText" />
+  <Icon icon="FileText" />
+</Col>
+
+<br />
+<br />
+<br />
+
+### Latex
+
+```mdx
+<Latex>
+E = mc^2
+</Latex>
+```
+
+<Latex>
+E = mc^2
+</Latex>
+
+<br />
+<br />
+<br />
+
+### Tables
+
+```mdx
+| Property | Description                           |
+| -------- | ------------------------------------- |
+| Name     | Full name of user                     |
+| Age      | Reported age                          |
+| Joined   | Whether the user joined the community |
+```
+
+| Property | Description                           |
+| -------- | ------------------------------------- |
+| Name     | Full name of user                     |
+| Age      | Reported age                          |
+| Joined   | Whether the user joined the community |
+
+
+### Steps
+
+```mdx
+<Steps>
+  <Step title="First Step">
+  This is the first step in the process.
+  </Step>
+  <Step title="Second Step">
+  This is the second step in the process.
+  </Step>
+</Steps>
+```
+
+<Steps>
+  <Step title="First Step">
+  This is the first step in the process.
+  </Step>
+  <Step title="Second Step">
+  This is the second step in the process.
+  </Step>
+</Steps>
+
+### Icons
+
+```mdx
+<Col rows={2}>
+  <Icon icon="Code" />
+  <Icon icon="FileText" />
+  <Icon icon="CheckCircle" />
+</Col>
+```
+
+<Row cols={3}>
+<Icon icon="Code" />
+<Icon icon="FileText" />
+<Icon icon="CheckCircle" />
+</Row>

package/dist/frontmatter.json

@@ -0,0 +1,77 @@
+[
+  {
+    "title": "Introduction",
+    "description": "Welcome to Docucod and Dory documentation",
+    "path": "/introduction"
+  },
+  {
+    "title": "Features",
+    "description": "Overview of available components and features",
+    "path": "/features"
+  },
+  {
+    "title": "WebSocket Playground Demo",
+    "description": "Interactive WebSocket playground for testing real-time connections",
+    "path": "/websocket-playground-demo"
+  },
+  {
+    "title": "POST /products",
+    "description": "Create a new product",
+    "openapi": "POST /products",
+    "path": "/api-reference/operations/create"
+  },
+  {
+    "title": "GET /products",
+    "description": "Get a list of products",
+    "openapi": "GET /products",
+    "path": "/api-reference/operations/get"
+  },
+  {
+    "title": "PUT /products/{id}",
+    "description": "Update a product",
+    "openapi": "PUT /products/{id}",
+    "path": "/api-reference/operations/update"
+  },
+  {
+    "title": "DELETE /products/{id}",
+    "description": "Delete a product",
+    "openapi": "DELETE /products/{id}",
+    "path": "/api-reference/operations/delete"
+  },
+  {
+    "title": "PUBLISH /chat",
+    "description": "Send a chat message to other users",
+    "asyncapi": "publish /chat",
+    "path": "/api-reference/websocket-operations/send-chat-message"
+  },
+  {
+    "title": "SUBSCRIBE /chat",
+    "description": "Subscribe to receive chat messages from other users",
+    "asyncapi": "subscribe /chat",
+    "path": "/api-reference/websocket-operations/receive-chat-message"
+  },
+  {
+    "title": "SUBSCRIBE /notifications",
+    "description": "Subscribe to receive system notifications",
+    "asyncapi": "subscribe /notifications",
+    "path": "/api-reference/websocket-operations/receive-notifications"
+  },
+  {
+    "title": "PUBLISH /presence",
+    "description": "Send a presence update",
+    "asyncapi": "publish /presence",
+    "path": "/api-reference/websocket-operations/send-presence-update"
+  },
+  {
+    "title": "SUBSCRIBE /presence",
+    "description": "Subscribe to receive user presence updates",
+    "asyncapi": "subscribe /presence",
+    "path": "/api-reference/websocket-operations/receive-presence-update"
+  },
+  {
+    "title": "API Playground Demo",
+    "description": "Interactive API playground for testing HTTP endpoints",
+    "openapi": "POST /plants",
+    "path": "/api-playground-demo"
+  }
+]

package/dist/index.html

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="/assets/favicon-Z67lNtJu.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    
+    <!-- Primary Meta Tags -->
+    <meta name="description" content="Docucod generates and maintains up-to-date documentation from your codebase so your team can move fast, onboard quickly, and stay focused on building." />
+    <meta name="keywords" content="documentation, code documentation, auto documentation, developer tools, technical documentation, codebase documentation, llm, ai, anthropic, openai, chatgpt, claude, clidey" />
+    <meta name="author" content="Clidey" />
+    <meta name="language" content="English" />
+    
+    <!-- Open Graph / Facebook -->
+    <meta property="og:title" content="Docucod: Generate and Maintain Documentation With No Work" />
+    <meta property="og:description" content="Docucod auto-generates and maintains up-to-date documentation from your codebase so your team can move fast, onboard quickly, and stay focused on building." />
+    <meta property="og:image" content="/assets/favicon-Z67lNtJu.svg" />
+    <meta property="og:url" content="https://docucod.com/" />
+    <meta property="og:type" content="website" />
+    <meta property="og:site_name" content="Docucod" />
+    <meta property="og:locale" content="en_US" />
+    
+    <!-- Twitter -->
+    <meta name="twitter:card" content="summary_large_image" />
+    <meta name="twitter:title" content="Docucod: Generate and Maintain Documentation With No Work" />
+    <meta name="twitter:description" content="Docucod auto-generates and maintains up-to-date documentation from your codebase so your team can move fast, onboard quickly, and stay focused on building." />
+    <meta name="twitter:image" content="/assets/favicon-Z67lNtJu.svg" />
+    <meta name="twitter:site" content="@ClideyOfficial" />
+    <meta name="twitter:creator" content="@ClideyOfficial" />
+
+    <link rel="apple-touch-icon" href="/assets/favicon-Z67lNtJu.svg" />
+    <link rel="manifest" href="/manifest.json" />
+    
+    <title>Docucod - Instantly Generate and Maintain Your Documentation</title>
+
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link href="https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Inter&display=swap" rel="stylesheet">
+
+    <script>
+        !function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.crossOrigin="anonymous",p.async=!0,p.src=s.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="init be ys Ss me gs ws capture Ne calculateEventProperties xs register register_once register_for_session unregister unregister_for_session Rs getFeatureFlag getFeatureFlagPayload isFeatureEnabled reloadFeatureFlags updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures on onFeatureFlags onSurveysLoaded onSessionId getSurveys getActiveMatchingSurveys renderSurvey canRenderSurvey canRenderSurveyAsync identify setPersonProperties group resetGroups setPersonPropertiesForFlags resetPersonPropertiesForFlags setGroupPropertiesForFlags resetGroupPropertiesForFlags reset get_distinct_id getGroups get_session_id get_session_replay_url alias set_config startSessionRecording stopSessionRecording sessionRecordingStarted captureException loadToolbar get_property getSessionProperty Is ks createPersonProfile Ps bs opt_in_capturing opt_out_capturing has_opted_in_capturing has_opted_out_capturing clear_opt_in_out_capturing $s debug Es getPageViewId captureTraceFeedback captureTraceMetric".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
+        posthog.init('phc_hxwfcMiIgSXYKkbWl9zpQE0HaPPmlRaVXCWODricYu1', {
+            api_host: 'https://us.i.posthog.com',
+            person_profiles: 'identified_only', // or 'always' to create profiles for anonymous users as well
+        })
+    </script>
+    <script type="module" crossorigin src="/assets/index-vOROtq-e.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-CGd7uPvh.css">
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="app"></div>
+  </body>
+</html>

package/dist/introduction.mdx

@@ -0,0 +1,44 @@
+---
+title: 'Introduction'
+description: 'Welcome to Docucod and Dory documentation'
+---
+
+# Introduction
+
+## Welcome to Docucod and Dory
+
+This documentation is powered by two complementary tools:
+
+1. **Docucod** - An AI-powered documentation assistant that automatically generates and maintains documentation
+2. **Dory** - A lightweight static site generator specifically designed to deploy Docucod-generated documentation
+
+## What is Docucod?
+
+Docucod analyzes your codebase and automatically:
+- Generates comprehensive documentation
+- Updates existing documentation when code changes
+- Maintains consistent style and formatting
+- Ensures accuracy and completeness
+
+## What is Dory?
+
+Dory is a lightweight static site generator built for developers who want fast, clean, and customizable documentation. It was created specifically to deploy Docucod-generated documentation with:
+
+- 🧠 **Simple** — Drop in `.mdx` files and configure one `dory.json`
+- ⚡ **Fast** — Instant hot reload in dev, quick static builds for prod
+- 🌐 **Portable** — No SSR, no lock-in, deploy anywhere
+- 🧩 **Flexible** — Hackable theme, readable codebase, minimal magic
+
+## Documentation Structure
+
+This documentation is organized to help you:
+- Get started quickly with both Docucod and Dory
+- Understand core concepts and features
+- Follow best practices and examples
+- Find detailed API references
+
+Let's begin exploring Docucod and Dory's capabilities!
+
+<br/>
+<br/>
+<br/>