Skip to content

Add troubleshooting pages best practices guide#4895

Closed
mintlify-development[bot] wants to merge 1 commit intomainfrom
mintlify/troubleshooting-guide-1774482553
Closed

Add troubleshooting pages best practices guide#4895
mintlify-development[bot] wants to merge 1 commit intomainfrom
mintlify/troubleshooting-guide-1774482553

Conversation

@mintlify-development
Copy link
Contributor

@mintlify-development mintlify-development bot commented Mar 25, 2026

Summary

  • Added a new Troubleshooting pages guide under Best practices in the Guides tab
  • Covers when to write troubleshooting content, how to structure each issue (symptom → cause → solution), writing tips for discoverability, and guidance on keeping content current
  • Added to the English navigation in docs.json

Note

Low Risk
Documentation-only change that adds a new guide and a navigation entry; no runtime or behavioral impact beyond site navigation/content.

Overview
Adds a new guides/troubleshooting-pages.mdx best-practices guide describing when to create troubleshooting content, a consistent symptom→cause→solution format, and tips for discoverability and maintenance.

Updates docs.json to surface the new page under Guides → Best practices navigation.

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

@mintlify
Copy link
Contributor

mintlify bot commented Mar 25, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Mar 25, 2026, 11:51 PM

@ethanpalm ethanpalm closed this Mar 26, 2026
@ethanpalm ethanpalm deleted the mintlify/troubleshooting-guide-1774482553 branch March 26, 2026 00:23
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.

1 participant