Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Dec 5, 2025

Documentation changes

This PR updates docs based on customer feedback.

  • Explain limitations of nesting in navigation elements and add more examples
  • Document that we support AI SDK v4

For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Updates assistant integration to AI SDK v4 with required useChat config and refines navigation docs with nesting rules, global anchors, and examples; clarifies OpenAPI field descriptions.

  • Assistant integration (api/assistant/create-assistant-message.mdx):
    • Recommend AI SDK v4 with install instructions and note about v5 custom transport.
    • Update useChat example: add retrievalPageSize, keep fp, require streamProtocol: 'data' and sendExtraMessageFields: true.
    • Add a concise list of required Mintlify config fields.
  • Navigation docs (organize/navigation.mdx):
    • Add guidance to choose a single root navigation pattern and one child type per level.
    • Clarify menus: items can only contain groups, pages, and external links.
    • Add/expand Global anchors section with requirements note.
    • Overhaul Nesting: add multiple structured examples (tabs↔anchors, products with tabs, multi-product with menu, versioned tabs).
  • OpenAPI schema (discovery-openapi.json):
    • Clarify fp description and expand retrievalPageSize description for /assistant/{domain}/message.

Written by Cursor Bugbot for commit 11da8aa. This will update automatically on new commits. Configure here.

Copy link
Contributor

Choose a reason for hiding this comment

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

This looks good, but could we also update the openapi spec here: openapi: POST /assistant/{domain}/message

with the extra parameters we added

@ethanpalm ethanpalm merged commit c0e340d into main Dec 5, 2025
5 checks passed
@ethanpalm ethanpalm deleted the feedback-12-4 branch December 5, 2025 03:21
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