Add reference documentation use cases guide#3587
Open
mintlify[bot] wants to merge 2 commits intomainfrom
Open
Conversation
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
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
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.
Created a new guide explaining when and how to use reference documentation effectively. Added the page to the Best practices section in the Guides navigation.
Files changed:
guides/reference-use-cases.mdx- New page covering reference documentation use cases, characteristics, and best practicesdocs.json- Added new page to Guides > Best practices navigationNote
Low Risk
Content-only documentation addition plus a navigation entry; no runtime logic or data/security behavior changes.
Overview
Adds a new guide page,
guides/reference-use-cases.mdx, describing when to use reference documentation, what it is/isn’t, common use cases, and best practices.Updates
docs.jsonto include the new page under Guides → Best practices so it appears in navigation.Written by Cursor Bugbot for commit c72c81c. This will update automatically on new commits. Configure here.