Repository navigation
Publish conversation examples to the docs Cookbook tab - #13
jpshackelford wants to merge 3 commits into
Conversation
Co-authored-by: openhands <openhands@all-hands.dev>
Docs preview✅ Docs preview is ready: https://allhandsai-cookbook-preview-pr-13.mintlify.site
Docs PR: OpenHands/docs#896 (draft preview; never merged, closes with this PR). |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Good work publishing these conversation monitoring examples! All 5 new example.yaml files are correctly structured with valid categories, unique icons, and Title Case titles. The npm run check passes cleanly.
One issue found: the conversation-tags README title needs to be updated to match the example.yaml title.
[RISK ASSESSMENT]
Risk level: LOW
- Changes are metadata-only (example.yaml files and README titles)
- All examples render cleanly
- No code or functional changes
Was this automated review useful? React with 👍 or 👎 to this review to help us measure review quality.
Workflow run: https://github.com/OpenHands/enterprise-cookbook/actions/runs/37359595945
| @@ -1,5 +1,5 @@ | |||
| --- | |||
| title: Conversation tags | |||
| title: Conversation Tags | |||
There was a problem hiding this comment.
🟠 Important: The README title must match the example.yaml title. The README currently has:
# Attach metadata to a conversation with tagsBut example.yaml now has title: Conversation Tags. According to STYLEGUIDE.md (line 66):
The example's name in Title Case. On the docs site it is replaced by the title in example.yaml, so make them match.
This is also part of the required upleveling checklist (line 273).
| title: Conversation Tags | |
| title: Conversation Tags |
Please update conversation-tags/README.md line 1 to:
# Conversation TagsThe plugins payload still loaded from the archived jpshackelford/oh-examples. Only the source changes; the message and other parameters are unchanged. Co-authored-by: openhands <openhands@all-hands.dev>
… merge) Preview of the Enterprise Cookbook pages produced by OpenHands/enterprise-cookbook#13 (Publish conversation examples to the docs Cookbook tab), rendered from OpenHands/enterprise-cookbook@41aebcc. **Do not merge.** This draft exists only to get a Mintlify preview. It is updated on every push to the source PR and closed when that PR closes. Merged changes reach the docs through a separate `cookbook-sync` PR. _Opened automatically by the docs-preview workflow in OpenHands/enterprise-cookbook._
Co-authored-by: openhands <openhands@all-hands.dev>
… merge) Preview of the Enterprise Cookbook pages produced by OpenHands/enterprise-cookbook#13 (Publish conversation examples to the docs Cookbook tab), rendered from OpenHands/enterprise-cookbook@b73c7c4. **Do not merge.** This draft exists only to get a Mintlify preview. It is updated on every push to the source PR and closed when that PR closes. Merged changes reach the docs through a separate `cookbook-sync` PR. _Opened automatically by the docs-preview workflow in OpenHands/enterprise-cookbook._
2 participants
Why
This PR publishes 6 examples in the Conversation monitoring & reacting category:
Validation
npm run check: ✅ All 7 examples render cleanlyThis PR was created by an AI agent (OpenHands) on behalf of the user.