Skip to content

Add link to docs.json schema to AI tool guides #956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jul 25, 2025
Merged

Add link to docs.json schema to AI tool guides #956

merged 1 commit into from
Jul 25, 2025

Conversation

ethanpalm
Copy link
Contributor

Documentation changes

This PR links to https://mintlify.com/docs.json in all the example rules for AI assistants.

Closes https://linear.app/mintlify/issue/DOC-124/add-docsjson-reference-to-all-ai-rules

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

@ethanpalm ethanpalm merged commit 35f1ca8 into main Jul 25, 2025
5 checks passed
@ethanpalm ethanpalm deleted the add-docsjosn-ai-context branch July 25, 2025 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dks333 dks333 dks333 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ethanpalm @dks333