Skip to content

docs: add prompt playground documentation with setup guide and feature overview#2112

Merged
akshaydeo merged 1 commit intomainfrom
03-16-docs_prompt_repo
Mar 17, 2026
Merged

docs: add prompt playground documentation with setup guide and feature overview#2112
akshaydeo merged 1 commit intomainfrom
03-16-docs_prompt_repo

Conversation

@impoiler
Copy link
Copy Markdown
Contributor

@impoiler impoiler commented Mar 16, 2026

Summary

Adds comprehensive documentation for the Prompt Repository Playground feature, providing users with a complete guide to creating, testing, and versioning prompts in Bifrost's interactive workspace.

Changes

  • Added new "Prompt Repository" section to documentation navigation with playground page
  • Created detailed playground documentation covering core concepts (folders, prompts, sessions, versions)
  • Documented the three-panel workspace layout and getting started workflow
  • Included key capabilities like version control, multi-provider testing, message types, attachments, and session management
  • Added 7 supporting images showing the UI and workflow
  • Applied minor CSS styling fix for sidebar group line height

Type of change

  • Bug fix
  • Feature
  • Refactor
  • Documentation
  • Chore/CI

Affected areas

  • Core (Go)
  • Transports (HTTP)
  • Providers/Integrations
  • Plugins
  • UI (Next.js)
  • Docs

How to test

Verify the documentation renders correctly and navigation works:

# Navigate to docs directory and serve locally
cd docs
# Follow your documentation framework's serve command
# Verify new "Prompt Repository" section appears in navigation
# Confirm playground.mdx page loads with all images
# Test internal links and formatting

Screenshots/Recordings

The documentation includes 7 new screenshots demonstrating:

  • Prompt repository overview
  • Workspace layout
  • Folder creation
  • Prompt creation
  • Playground interface
  • Version commit flow
  • Session management

Breaking changes

  • Yes
  • No

Related issues

Documents the Prompt Repository Playground feature for user onboarding and reference.

Security considerations

Documentation only - no security implications.

Checklist

  • I read docs/contributing/README.md and followed the guidelines
  • I added/updated tests where appropriate
  • I updated documentation where needed
  • I verified builds succeed (Go and UI)
  • I verified the CI pipeline passes locally if applicable

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 16, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Added comprehensive Prompt Repository Playground docs: overview, core concepts (Folders, Prompts, Sessions, Versions), workspace layout, getting started, UI/workflow for creating and publishing immutable prompt versions, sessions management, version control, multi-provider testing, message types, attachments, and drag-and-drop organization.
    • Added a new "Prompt Repository" navigation group linking to the Playground page.
  • Style

    • Minor sidebar navigation line-height and formatting adjustments.

Walkthrough

Adds documentation for a new Prompt Repository Playground: a navigation group entry, a new playground guide page, and a small CSS adjustment to sidebar styling. No functional code or API surface changes.

Changes

Cohort / File(s) Summary
Documentation Navigation
docs/docs.json
Inserted a new "Prompt Repository" navigation group with icon "folder" linking to the playground page.
Playground Feature Guide
docs/features/prompt-repository/playground.mdx
Added a new comprehensive Playground documentation page describing core concepts (Folders, Prompts, Sessions, Versions), workspace layout, workflows, and capabilities (versioning, multi-provider testing, attachments, drag-and-drop).
Styling Updates
docs/style.css
Added line-height: normal rule for #sidebar-group > li > button > div and minor formatting adjustments around .nav-logo block.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 In docs I hop, a tidy trail I weave,
Folders and prompts in a bright reprieve,
Sessions kept safe, versions snug and sound,
Sidebar smoothed so navigation's found,
Hooray — the Playground's written, neat and keen!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for the prompt playground feature with setup guide and feature overview, which directly matches the PR's core objective.
Description check ✅ Passed The description comprehensively follows the template with all required sections completed: summary, changes, type (documentation), affected areas (docs), testing steps, screenshots listed, breaking changes, related issues, security considerations, and a fully checked checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 03-16-docs_prompt_repo
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

@impoiler impoiler force-pushed the 03-16-docs_prompt_repo branch from 079faad to 9d2c2f3 Compare March 16, 2026 17:28
@impoiler impoiler force-pushed the 03-16-prompt_playground_messages_view_ui_improvements branch from f613a9c to 2ef199a Compare March 16, 2026 17:28
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 16, 2026

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@impoiler impoiler force-pushed the 03-16-docs_prompt_repo branch 2 times, most recently from 2f821ac to 4446be8 Compare March 16, 2026 18:56
@impoiler impoiler force-pushed the 03-16-prompt_playground_messages_view_ui_improvements branch from 2ef199a to e198aa3 Compare March 16, 2026 18:56
@impoiler impoiler force-pushed the 03-16-docs_prompt_repo branch from 4446be8 to a622a3b Compare March 16, 2026 19:01
@impoiler impoiler force-pushed the 03-16-prompt_playground_messages_view_ui_improvements branch from e198aa3 to 621b2a8 Compare March 16, 2026 19:01
@akshaydeo akshaydeo changed the base branch from 03-16-prompt_playground_messages_view_ui_improvements to graphite-base/2112 March 16, 2026 19:31
@akshaydeo akshaydeo force-pushed the 03-16-docs_prompt_repo branch from a622a3b to 5046eef Compare March 16, 2026 19:33
@akshaydeo akshaydeo force-pushed the graphite-base/2112 branch from 621b2a8 to 82e37b2 Compare March 16, 2026 19:33
@graphite-app graphite-app Bot changed the base branch from graphite-base/2112 to main March 16, 2026 19:34
@akshaydeo akshaydeo force-pushed the 03-16-docs_prompt_repo branch from 5046eef to 1664956 Compare March 16, 2026 19:34
@impoiler impoiler force-pushed the 03-16-docs_prompt_repo branch from 1664956 to 87dc2d8 Compare March 17, 2026 03:47
@impoiler impoiler changed the title docs prompt repo docs: add prompt playground documentation with setup guide and feature overview Mar 17, 2026
@impoiler impoiler self-assigned this Mar 17, 2026
@impoiler impoiler force-pushed the 03-16-docs_prompt_repo branch 5 times, most recently from 380a9b1 to 4e310a2 Compare March 17, 2026 09:07
@impoiler impoiler marked this pull request as ready for review March 17, 2026 09:15
@impoiler impoiler force-pushed the 03-16-docs_prompt_repo branch from 4e310a2 to e4be9d9 Compare March 17, 2026 09:16
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
docs/style.css (1)

6-7: Use a less brittle selector for sidebar text styling.

The selector #sidebar-group > li > button > div depends on Mintlify's internal DOM structure, which is not guaranteed to remain stable. Mintlify explicitly warns that styling references are "subject to change as the platform evolves." Instead, prefer Mintlify's documented selector hooks (e.g., published identifiers like sidebar-group-header) or semantic data-attributes (e.g., data-component) for long-term compatibility. Verify the current Mintlify theme's rendered HTML via DevTools to identify the recommended stable hooks.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/style.css` around lines 6 - 7, The selector "#sidebar-group > li >
button > div" is brittle; inspect the Mintlify theme in DevTools to find the
documented stable hook (e.g., the published identifier like
"sidebar-group-header" or a semantic data-attribute such as
data-component="sidebar-group-header"), then replace the fragile selector in
docs/style.css with the stable hook selector (target the same element that needs
line-height: normal using the identified class or data-attribute) so styling
relies on Mintlify's supported DOM hooks rather than the internal child
structure.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/features/prompt-repository/playground.mdx`:
- Around line 49-53: Choose one canonical keyboard shortcut for the Save Session
vs Run actions and make the docs consistent: keep the existing "Cmd + S / Ctrl +
S" mapping for either the "Save Session" entry or the "Run" entry, then update
the other occurrence to a different, unconflicting shortcut (e.g., "Cmd + Enter
/ Ctrl + Enter") and update both instances of that action's text so "Save
Session" and "Run" no longer share the same shortcut; ensure you update both the
top-bar mention under the "Save Session" paragraph and the separate "Run"
paragraph so the file's references to "Save Session" and "Run" are consistent.
- Line 15: The sentence "The playground is built around four core concepts:
**Prompts, Sessions, and Versions**." misstates the count; update that line to
either include Folders in the list or change "four" to "three". Specifically,
edit the sentence string to read either "The playground is built around four
core concepts: **Prompts, Sessions, Versions, and Folders**." or "The playground
is built around three core concepts: **Prompts, Sessions, and Versions**." so
the numeric count matches the listed items.

---

Nitpick comments:
In `@docs/style.css`:
- Around line 6-7: The selector "#sidebar-group > li > button > div" is brittle;
inspect the Mintlify theme in DevTools to find the documented stable hook (e.g.,
the published identifier like "sidebar-group-header" or a semantic
data-attribute such as data-component="sidebar-group-header"), then replace the
fragile selector in docs/style.css with the stable hook selector (target the
same element that needs line-height: normal using the identified class or
data-attribute) so styling relies on Mintlify's supported DOM hooks rather than
the internal child structure.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c1888217-c7bd-4608-b973-0f06c666216e

📥 Commits

Reviewing files that changed from the base of the PR and between 06cefd4 and e4be9d9.

⛔ Files ignored due to path filters (7)
  • docs/media/prompt-repo-commit.png is excluded by !**/*.png
  • docs/media/prompt-repo-create-folder.png is excluded by !**/*.png
  • docs/media/prompt-repo-create-prompt.png is excluded by !**/*.png
  • docs/media/prompt-repo-layout.png is excluded by !**/*.png
  • docs/media/prompt-repo-overview.png is excluded by !**/*.png
  • docs/media/prompt-repo-playground.png is excluded by !**/*.png
  • docs/media/prompt-repo-sessions.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • docs/docs.json
  • docs/features/prompt-repository/playground.mdx
  • docs/style.css

Comment thread docs/features/prompt-repository/playground.mdx Outdated
Comment thread docs/features/prompt-repository/playground.mdx
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/features/prompt-repository/playground.mdx (1)

131-137: Minor: Capitalize "Enter" in keyboard shortcut for consistency.

Keyboard shortcuts typically use title case. Line 53 uses Cmd + S (uppercase), but here "enter" is lowercase.

✏️ Suggested fix
-Click **Run** or press `Cmd + enter` / `Ctrl + enter`.
+Click **Run** or press `Cmd + Enter` / `Ctrl + Enter`.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/features/prompt-repository/playground.mdx` around lines 131 - 137,
Update the keyboard shortcut casing in the "Run the prompt" Step: change the
inline text from `Cmd + enter` / `Ctrl + enter` to `Cmd + Enter` / `Ctrl +
Enter` so it matches title-case usage elsewhere (e.g., `Cmd + S`) and maintains
consistency in the Step titled "Run the prompt".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/features/prompt-repository/playground.mdx`:
- Around line 131-137: Update the keyboard shortcut casing in the "Run the
prompt" Step: change the inline text from `Cmd + enter` / `Ctrl + enter` to `Cmd
+ Enter` / `Ctrl + Enter` so it matches title-case usage elsewhere (e.g., `Cmd +
S`) and maintains consistency in the Step titled "Run the prompt".

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c76a135e-0876-459a-a9e9-cb148fffe286

📥 Commits

Reviewing files that changed from the base of the PR and between e4be9d9 and e4300ea.

⛔ Files ignored due to path filters (7)
  • docs/media/prompt-repo-commit.png is excluded by !**/*.png
  • docs/media/prompt-repo-create-folder.png is excluded by !**/*.png
  • docs/media/prompt-repo-create-prompt.png is excluded by !**/*.png
  • docs/media/prompt-repo-layout.png is excluded by !**/*.png
  • docs/media/prompt-repo-overview.png is excluded by !**/*.png
  • docs/media/prompt-repo-playground.png is excluded by !**/*.png
  • docs/media/prompt-repo-sessions.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • docs/docs.json
  • docs/features/prompt-repository/playground.mdx
  • docs/style.css
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/style.css

Copy link
Copy Markdown
Contributor

akshaydeo commented Mar 17, 2026

Merge activity

  • Mar 17, 12:54 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Mar 17, 12:54 PM UTC: @akshaydeo merged this pull request with Graphite.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants