@clidey/dory 0.1.0 → 0.2.0

package/docs/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/docs/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/>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@clidey/dory",
   "private": false,
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "description": "A CLI tool for building and previewing documentation sites",
   "keywords": [
@@ -27,7 +27,8 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc -b && vite build",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "publish": "npm publish --access public"
   },
   "dependencies": {
     "@algolia/autocomplete-core": "^1.19.2",

package/src/mdx/source.tsx

@@ -1,6 +1,6 @@
 type PathRange = {
     path: string;
-    range: string;
+    range?: string;
 };
 
 type SourceProps = {
@@ -10,7 +10,18 @@ type SourceProps = {
 };
 
 export const Source = ({ url, branch = "main", paths }: SourceProps) => {
-    const createSourceUrl = (path: string, range: string) => {
+    const createSourceUrl = (path: string, range?: string) => {
+        if (!range) {
+            if (url.includes('github.com')) {
+                return `${url}/blob/${branch}/${path}`;
+            } else if (url.includes('bitbucket.org')) {
+                return `${url}/src/${branch}/${path}`;
+            } else if (url.includes('gitlab.com')) {
+                return `${url}/-/blob/${branch}/${path}`;
+            }
+            return url;
+        }
+
         const [start, end] = range.split('-');
 
         if (url.includes('github.com')) {
@@ -29,7 +40,7 @@ export const Source = ({ url, branch = "main", paths }: SourceProps) => {
             <p className="text-sm text-slate-900 dark:text-white">Sources:</p>
             <ul className="list-none pl-0 flex flex-wrap gap-2 mt-2">
                 {paths.map(({ path, range }) => (
-                    <li key={path + range}>
+                    <li key={path + (range || '')}>
                         <a
                             href={createSourceUrl(path, range)}
                             target="_blank"
@@ -37,7 +48,7 @@ export const Source = ({ url, branch = "main", paths }: SourceProps) => {
                             className="rounded px-3 py-1 font-mono text-sm text-slate-700 dark:text-slate-400 hover:opacity-80 transition-colors border border-slate-200 dark:border-slate-700"
                         >
                             {path}
-                            <span className="ml-2 opacity-70">{range}</span>
+                            {range && <span className="ml-2 opacity-70">{range}</span>}
                         </a>
                     </li>
                 ))}

package/docs/README.md

@@ -1,2 +0,0 @@
-# genie-internal
-Created via Docucod

package/docs/configuration/app-settings/feature-flags.mdx

@@ -1,157 +0,0 @@
----
-title: 'Feature Flags'
-description: 'Manage and understand feature flags affecting the application behavior.'
----
-
-# Feature Flags
-
-## Purpose and Scope
-
-The Feature Flags module provides a centralized mechanism to enable or disable specific features within the Genie application dynamically. This approach allows controlled rollout, testing, and gradual adoption of new functionalities without deploying new code versions.
-
-This module primarily parses and validates feature flag configurations from environment variables and exposes them for use throughout the web and API services.
-
-## Technical Overview
-
-Feature Flags are defined and validated using the `zod` schema validation library to ensure that flag values comply with expected types. Flags can generally be boolean or strings convertible to booleans (`"true"`), permitting flexibility in how environment variables are specified.
-
-The parsing logic safely attempts to read environment variables, falling back to an empty object on failure and capturing exceptions with Sentry for monitoring.
-
-### Key Locations
-
-- **Web client feature flags:** Defined and parsed in `apps/web/src/utils/feature-flags.ts`.
-- **API service feature flags:** Defined under API config schemas in `apps/api/src/config/schemas/index.ts`.
-
-
-## Core Concepts and Responsibilities
-
-- **Feature Flags Schema:** A set of typed mappings that describe each flag's expected type and optional presence.
-- Flags can be a boolean or a string (`"true"` interpreted as `true`) or undefined.
-- Certain flags have additional typed definitions such as arrays, e.g., `DEMAND_PLANNER_SHOP_ALLOW_LIST` which is an optional array of strings.
-
-- **Error Handling:** Parsing errors are logged to Sentry via `Sentry.captureException(error)` to facilitate early detection of misconfiguration.
-
-- **Environmental Scope:** Flags are read from environment variables prefixed with `NEXT_PUBLIC_FEATURE_FLAGS` for frontend exposure or `FEATURE_FLAGS` for the backend.
-
-- **Security and Scope:** Flags must be explicitly defined in environment configuration, preventing undefined or unexpected flags from being used.
-
-## Code Structure
-
-### `apps/web/src/utils/feature-flags.ts`
-
-This file implements the feature flag parsing logic for the web frontend.
-
-- `flagSchema`: Accepts either a boolean or a string representing booleans and transforms the string to a boolean.
-- `featureFlagsSchema`: Defines known feature flags such as `UI_PAGE`, `DEMAND_PLANNER`, `MOV`, `PAYMENT_TERMS`, and others. Some flags are booleans, others arrays of strings.
-- `parseFeatureFlags()`:
-  - Attempts to JSON parse the environment variable `NEXT_PUBLIC_FEATURE_FLAGS`.
-  - Validates it against the schema.
-  - On error, logs to Sentry and returns an empty object.
-- `FEATURE_FLAGS`: Exported constant representing the parsed flags for app-wide consumption.
-
-```ts
-import { z } from "zod";
-import * as Sentry from "@sentry/nextjs";
-
-const flagSchema = z.union([
-  z.boolean(),
-  z.string().transform((val) => val === "true")
-]).optional();
-
-const featureFlagsSchema = z.object({
-  UI_PAGE: flagSchema,
-  DEMAND_PLANNER: flagSchema,
-  DEMAND_PLANNER_SHOP_ALLOW_LIST: z.array(z.string()).optional(),
-  MOV: flagSchema,
-  PAYMENT_TERMS: flagSchema,
-  MANUAL_STATUS: flagSchema,
-  REPORTS_ALERTS: flagSchema,
-  PAYMENTS_PAGE: flagSchema,
-});
-
-type FeatureFlags = z.infer<typeof featureFlagsSchema>;
-
-const parseFeatureFlags = (): FeatureFlags => {
-  try {
-    return featureFlagsSchema.parse(
-      JSON.parse(process.env.NEXT_PUBLIC_FEATURE_FLAGS || "{}")
-    );
-  } catch (error) {
-    Sentry.captureException(error);
-    return {};
-  }
-};
-
-export const FEATURE_FLAGS = parseFeatureFlags();
-```
-
-### `apps/api/src/config/schemas/index.ts`
-
-This file extends feature flag support within the API backend.
-
-- The API uses a similar schema (`featureFlagSchema`) that accepts booleans or strings convertible to booleans.
-- `featureFlagsSchema` is defined but currently empty (`z.object({} satisfies Record<string, typeof featureFlagSchema>)`).
-- The `FEATURE_FLAGS` environment variable is parsed and coerced to a string, then JSON parsed and validated.
-
-The config schema merges the feature flags, along with many other env vars, into a consolidated validation schema.
-
-```ts
-const featureFlagSchema = z.union([
-  z.boolean(),
-  z.string().transform((value) => value === "true")
-]).optional();
-
-const featureFlagsSchema = z.object(
-  {} satisfies Record<string, typeof featureFlagSchema>
-);
-
-export type FeatureFlags = z.infer<typeof featureFlagsSchema>;
-
-export const configSchema = z.object({
-  // ... other config fields ...
-  FEATURE_FLAGS: z.coerce.string().optional().transform((jsonString = "{}") =>
-    featureFlagsSchema.parse(JSON.parse(jsonString))
-  ),
-  // ... other config fields ...
-}).merge(databaseConfigSchema).strip();
-```
-
-## Environment & Configuration
-
-### Environment Variables
-
-- `NEXT_PUBLIC_FEATURE_FLAGS` (frontend): JSON string representing flags.
-- `FEATURE_FLAGS` (API backend): JSON string representing flags.
-
-Example environment value for frontend (simplified):
-
-```json
-{
-  "UI_PAGE": true,
-  "DEMAND_PLANNER": "true",
-  "DEMAND_PLANNER_SHOP_ALLOW_LIST": ["shop1", "shop2"],
-  "MOV": false
-}
-```
-
-The environment variable must be valid JSON and correctly typed for each feature flag.
-
-## Integration & System Boundaries
-
-- **Web UI:** Uses parsed `FEATURE_FLAGS` to enable/disable UI features.
-- **API:** Reads feature flags from environment on startup to alter backend behavior.
-- **Error Logging:** Parsing issues send errors to Sentry for diagnosis.
-
-## Observability & Error Handling
-
-- Parsing errors of feature flags are monitored via Sentry.
-- Apps fall back gracefully to default empty flags on error, ensuring stability.
-
-## Summary
-
-This feature flags module provides a robust, type-safe approach to managing application features dynamically through environment configuration. It ensures flags are validated on startup and exposes them as constants for consistent use across frontend and backend components.
-
-## References
-
-- [Feature Flags in Web Frontend](apps/web/src/utils/feature-flags.ts)
-- [Feature Flags in API Config](apps/api/src/config/schemas/index.ts)