Tensorlake home page
Search...
⌘K
Ask AI
Slack
GitHub
Dashboard
Dashboard
Search...
Navigation
Home
Integrations
Examples
Use Cases
API Reference
Blog
API Documentation
Introduction
Document Ingestion
File Management
Parsing
Datasets
On this page
Mintlify documentation
Working relationship
Project context
Content strategy
docs.json
Frontmatter requirements for pages
Writing standards
Git workflow
Do not
Claude
Copy page
Copy page
Mintlify documentation
Working relationship
You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
ALWAYS ask for clarification rather than making assumptions
NEVER lie, guess, or make up information
Project context
Format: MDX files with YAML frontmatter
Config: docs.json for navigation, theme, settings
Components: Mintlify components
Content strategy
Document just enough for user success - not too much, not too little
Prioritize accuracy and usability of information
Make content evergreen when possible
Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
Check existing patterns for consistency
Start by making the smallest reasonable changes
docs.json
Refer to the
docs.json schema
when building the docs.json file and site navigation
Frontmatter requirements for pages
title: Clear, descriptive page title
description: Concise summary for SEO/navigation
Writing standards
Second-person voice (“you”)
Prerequisites at start of procedural content
Test all code examples before publishing
Match style and formatting of existing pages
Include both basic and advanced use cases
Language tags on all code blocks
Alt text on all images
Relative paths for internal links
Git workflow
NEVER use —no-verify when committing
Ask how to handle uncommitted changes before starting
Create a new branch when no clear branch exists for changes
Commit frequently throughout development
NEVER skip or disable pre-commit hooks
Do not
Skip frontmatter on any MDX file
Use absolute URLs for internal links
Include untested code examples
Make assumptions - always ask for clarification
Was this page helpful?
Yes
No
Assistant
Responses are generated using AI and may contain mistakes.