Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Jan 7, 2026

Documentation changes

This PR adds content type templates that people can copy and modify and to help the assistant answer questions about content best practices.

Closes https://linear.app/mintlify/issue/DOC-227/templates-for-documentation-types


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

Add template guide for common content types

  • New guides/content-templates.mdx with editable templates for how-to, tutorial, explanation, and reference
  • Adds guides/content-templates to Guides > Best practices in docs.json
  • Updates guides/content-types.mdx to reference the new templates (tip + related card) and minor formatting cleanup
  • Updates guides/index.mdx to include a link to Content templates under Best practices

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

Copy link
Collaborator

@ruhanponnada ruhanponnada left a comment

Choose a reason for hiding this comment

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

like this a lot

@ethanpalm ethanpalm merged commit 8bbf508 into main Jan 7, 2026
5 checks passed
@ethanpalm ethanpalm deleted the content-templates branch January 7, 2026 18:12
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