diff --git a/README.md b/README.md index 6171882..8d0e3ad 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ -

Prompt Deck Logo

+

Prompt Deck Logo

Latest Version on Packagist PHP from Packagist GitHub license + + Total Downloads on Packagist + - https://laravel-news.com/prompt-deck-manage-ai-prompts-as-versioned-files-in-laravel - + Featured in Laravel News +

## Introduction diff --git a/docs/docs.json b/docs/docs.json index 0c4c296..2c804b8 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -9,40 +9,35 @@ }, "favicon": "/logo/logo.svg", "navigation": { - "tabs": [ + "groups": [ { - "tab": "Documentation", - "groups": [ - { - "group": "Getting started", - "pages": [ - "getting-started/introduction", - "getting-started/installation", - "getting-started/configuration" - ] - }, - { - "group": "Core concepts", - "pages": [ - "core/prompts", - "core/make-prompt", - "core/commands" - ] - }, - { - "group": "Integrations", - "pages": [ - "integrations/ai-sdk" - ] - }, - { - "group": "Advanced", - "pages": [ - "advanced/tracking", - "advanced/testing", - "advanced/api-reference" - ] - } + "group": "Getting started", + "pages": [ + "getting-started/introduction", + "getting-started/installation", + "getting-started/configuration" + ] + }, + { + "group": "Core concepts", + "pages": [ + "core/prompts", + "core/make-prompt", + "core/commands" + ] + }, + { + "group": "Integrations", + "pages": [ + "integrations/ai-sdk" + ] + }, + { + "group": "Advanced", + "pages": [ + "advanced/tracking", + "advanced/testing", + "advanced/api-reference" ] } ], @@ -50,7 +45,7 @@ "anchors": [ { "anchor": "GitHub", - "href": "https://github.com/veeqtoh/prompt-deck", + "href": "https://github.com/promptphp/prompt-deck", "icon": "github" }, { @@ -62,8 +57,8 @@ } }, "logo": { - "light": "/logo/logo.svg", - "dark": "/logo/logo.svg" + "light": "/logo/light.svg", + "dark": "/logo/dark.svg" }, "navbar": { "links": [ diff --git a/docs/index.mdx b/docs/index.mdx index d92452d..3e4befd 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -1,118 +1,103 @@ --- title: "Welcome" -description: Organize, version, and test your AI agent instructions with Prompt Deck, a powerful Laravel package for seamless AI integration. +description: Organise, version, and test your AI agent instructions with Prompt Deck, a powerful Laravel package for seamless AI integration. mode: "custom" --- {/* Top Accent Glow Effect */}
-
- {/* Hero Section */} -
- {/*
- ✨ Now available for Laravel 11+ -
*/} - -

- Prompt Deck -

- -

- Organise your AI Agent instructions as structured, version-controlled files in your Laravel application. -

- -
- - Get Started -
- - - GitHub - -
-
-
+
+ {/* Hero Section */} +
+ {/*
+ ✨ Now available for Laravel 11+ +
*/} -{/* Main Layout Wrapper */} -
- - {/* Interactive Feature Grid */} -
- - {/* Card 1 */} -
-
📁
-

Versioned Prompts

-

Organise instructions as versioned markdown structures directly inside your source control repository.

-
- - {/* Card 2 */} -
-
🔄
-

Interpolation

-

Inject application state instantly into your system prompts using clean, readable syntax at execution runtime.

-
- - {/* Card 3 */} -
-
📊
-

A/B Testing

-

Route LLM flows between different prompt iterations to track metrics and evaluate response consistency.

-
+

+ Prompt Deck +

- {/* Card 4 */} -
-
💻
-

Artisan Scaffold

-

Generate directories, active config variants, and markdown code structures quickly with command-line tooling.

-
+

+ Organise your AI Agent instructions as structured, version-controlled files in your Laravel application. +

- {/* Card 5 */} -
-
📈
-

Performance logs

-

Log historical execution speed and prompt token payloads inside internal metrics pipelines seamlessly.

+ +
- {/* Card 6 */} -
-
🔌
-

AI SDK Native

-

Uses trait mappings designed to natively inject files into Laravel AI SDK setups automatically.

+{/* Main Layout Wrapper */} +
+ {/* Interactive Feature Grid */} +
+ {/* Card 1 */} +
+
📁
+

Versioned Prompts

+

+ Store prompts as files on disk with directory-based versioning. +

+
+ {/* Card 2 */} +
+
🔄
+

Interpolation

+

+ Use `{{ $variable }}` syntax in prompt templates for dynamic content rendering. +

+
+ {/* Card 3 */} +
+
📊
+

Performance Tracking

+

+ Log executions with token usage, latency, cost, and feedback for A/B testing and monitoring. +

+
-
- {/* Interactive Code Preview Block */} -
-
+ {/* Interactive Code Preview Block */} +
+
-
-

Beautifully simple implementation

-

Manage file configurations via artisan and load compilation states natively into your codebases.

-
+
+

A workflow natural to you.

+

Run one artisan command, version your prompts.

+
- - ```bash Artisan Command - # Generate a versioned system prompt template - php artisan make:prompt order-summary - ``` + + ```bash Artisan Command + # Generate a versioned system prompt template + php artisan make:prompt order-summary + ``` - ```markdown Prompt File (v1/system.md) - You are a {{ $tone }} customer service agent. - Summarise the following order details: {{ $order }}. - ``` + ```markdown Prompt File (v1/system.md) + You are a {{ $tone }} customer service agent. + Summarise the following order details: {{ $order }}. + ``` - ```php Implementation (Controller) - use Veeqtoh\PromptDeck\Facades\PromptDeck; + ```php Implementation (Controller) + use Veeqtoh\PromptDeck\Facades\PromptDeck; - // Loads active markdown context and returns compiled payload arrays - $messages = PromptDeck::get('order-summary') - ->toMessages([ - 'tone' => 'friendly', - 'order' => $orderDetails - ]); - ``` - -
+ // Loads active markdown context and returns compiled payload arrays + $messages = PromptDeck::get('order-summary') + ->toMessages([ + 'tone' => 'friendly', + 'order' => $orderDetails + ]); + ``` + + +
diff --git a/docs/logo/banner.svg b/docs/logo/banner.svg new file mode 100644 index 0000000..e0f42cc --- /dev/null +++ b/docs/logo/banner.svg @@ -0,0 +1,8 @@ + + + + + + + \ No newline at end of file diff --git a/docs/logo/dark.svg b/docs/logo/dark.svg index 8b343cd..d7839dd 100644 --- a/docs/logo/dark.svg +++ b/docs/logo/dark.svg @@ -1,21 +1,8 @@ - - - - - - - - - - - - - - - - - - - - + + + + + + Prompt Deck + diff --git a/docs/logo/light.svg b/docs/logo/light.svg index 03e62bf..1917692 100644 --- a/docs/logo/light.svg +++ b/docs/logo/light.svg @@ -1,21 +1,8 @@ - - - - - - - - - - - - - - - - - - - - + + + + + + Prompt Deck + diff --git a/docs/logo/logo.svg b/docs/logo/logo.svg deleted file mode 100644 index 7792d44..0000000 --- a/docs/logo/logo.svg +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - \ No newline at end of file