docs: add prompt playground documentation with setup guide and feature overview#2112
docs: add prompt playground documentation with setup guide and feature overview#2112
Conversation
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
079faad to
9d2c2f3
Compare
f613a9c to
2ef199a
Compare
|
|
2f821ac to
4446be8
Compare
2ef199a to
e198aa3
Compare
4446be8 to
a622a3b
Compare
e198aa3 to
621b2a8
Compare
a622a3b to
5046eef
Compare
621b2a8 to
82e37b2
Compare
5046eef to
1664956
Compare
1664956 to
87dc2d8
Compare
380a9b1 to
4e310a2
Compare
4e310a2 to
e4be9d9
Compare
There was a problem hiding this comment.
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 > divdepends 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 likesidebar-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
⛔ Files ignored due to path filters (7)
docs/media/prompt-repo-commit.pngis excluded by!**/*.pngdocs/media/prompt-repo-create-folder.pngis excluded by!**/*.pngdocs/media/prompt-repo-create-prompt.pngis excluded by!**/*.pngdocs/media/prompt-repo-layout.pngis excluded by!**/*.pngdocs/media/prompt-repo-overview.pngis excluded by!**/*.pngdocs/media/prompt-repo-playground.pngis excluded by!**/*.pngdocs/media/prompt-repo-sessions.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/docs.jsondocs/features/prompt-repository/playground.mdxdocs/style.css
e4be9d9 to
e4300ea
Compare
There was a problem hiding this comment.
🧹 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
⛔ Files ignored due to path filters (7)
docs/media/prompt-repo-commit.pngis excluded by!**/*.pngdocs/media/prompt-repo-create-folder.pngis excluded by!**/*.pngdocs/media/prompt-repo-create-prompt.pngis excluded by!**/*.pngdocs/media/prompt-repo-layout.pngis excluded by!**/*.pngdocs/media/prompt-repo-overview.pngis excluded by!**/*.pngdocs/media/prompt-repo-playground.pngis excluded by!**/*.pngdocs/media/prompt-repo-sessions.pngis excluded by!**/*.png
📒 Files selected for processing (3)
docs/docs.jsondocs/features/prompt-repository/playground.mdxdocs/style.css
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/style.css
Merge activity
|

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
Type of change
Affected areas
How to test
Verify the documentation renders correctly and navigation works:
Screenshots/Recordings
The documentation includes 7 new screenshots demonstrating:
Breaking changes
Related issues
Documents the Prompt Repository Playground feature for user onboarding and reference.
Security considerations
Documentation only - no security implications.
Checklist
docs/contributing/README.mdand followed the guidelines