docs: address user feedback from the last month#6389
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reviewed user-reported feedback from the last month (Linear DOC team tickets from Jun 6 – Jul 6). Three items were actionable as docs updates now:
api-playground/overview.mdx). Explains the/_mintlify/api/requestproxy path, what metadata is captured, and how to disable the proxy withapi.playground.proxy: false.menusupport inside a product division (organize/navigation.mdx). Adds a "Product menus" subsection with a JSON example for the multi-column product panel.@MintlifyPR mention workflow (agent/index.mdx). Adds a "Trigger the agent from a pull request" section covering scope, prerequisites, and typical use cases.Deferred (not included in this PR):
Validated with
mint validateandmint broken-links— both pass.Generated by Mintlify Agent.
Requested by: hahnbee@mintlify.com via Slack
Mintlify session: slack_1783303534.996449_C0A6A37P2AK
Note
Low Risk
Documentation-only updates with no application code or configuration changes.
Overview
Adds three user-requested documentation sections across agent, API playground, and navigation guides.
Agent (
agent/index.mdx) — New Trigger the agent from a pull request section: comment@Mintlifyon a PR in a connected code repo to get a follow-up docs PR (uses PR title/description/diff; requires the GitHub App on both code and docs repos).API playground (
api-playground/overview.mdx) — New Request proxy and logging section: documents default routing via/_mintlify/api/request, what metadata Mintlify logs vs. what is not stored, and disabling the proxy withapi.playground.proxy: false(CORS, analytics, andcredentials).Navigation (
organize/navigation.mdx) — New Product menus subsection under Products:menuon a product entry for a multi-column product switcher panel, with a JSON example (groups, pages, external links).Reviewed by Cursor Bugbot for commit 6ca6687. Bugbot is set up for automated code reviews on this repo. Configure here.