Documentation Index

Fetch the complete documentation index at: https://docs.dovetail.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Dovetail docs — AI assistant guide

​

Voice and tone

• Second person. Address the reader as “you” / “your”. Use “we” / “our” sparingly, only when speaking for Dovetail-the-company.
• Conversational but professional. Contractions are fine (“you’ll”, “it’s”). Avoid corporate filler (“leverage”, “utilise”, “robust solution”).
• Problem before solution. Lead with the user’s situation, then introduce the feature. e.g. “The real hurdle isn’t talking, it’s listening” → then the feature.
• Benefit-driven section headings. Prefer “Why use X?” / “What can I do with X?” over “Overview” / “Introduction”.
• Active voice. “Dovetail centralizes your insights” — not “Insights are centralized by Dovetail”.
• No hype. Skip “revolutionary”, “game-changing”, “powerful”, “seamless”. Describe what it does.

​

Grammar and punctuation

• Oxford comma. Always: “sales calls, product reviews, and continuous feedback”.
• Sentence case for all headings (H1, H2, H3). Capitalize the first word and proper nouns only. “Create highlights for important moments” — not “Create Highlights For Important Moments”.
• Bullet lists: end each item with a period when the item is a complete sentence. Fragments don’t need terminal punctuation, but be consistent within a single list.
• US English throughout: “centralize”, “organization”, “analyze”, “behavior”, “color”. Even though Dovetail is an Australian company, the docs are written in US English — don’t switch to British spellings.
• Em dashes with spaces around them — like this — not en dashes or double hyphens.
• Numbers: spell out one to nine; use numerals for 10+. Exceptions: percentages, measurements, version numbers.

​

Product term capitalization

• ✅ Capitalized: Dovetail, Projects, Channels, Chat, Docs, Highlights, Tags, Fields, Insights, Notes, Recruit, AI Magic
• ✅ Lowercase when generic: “create a project”, “add a tag”, “review your channels”
• ⚠️ Note on Docs: the “Insights” feature was recently renamed to “Docs”. Use “Docs” going forward — but be aware older content may still say “Insights”.

​

Mintlify components

​

Images

• Embed with markdown: ![Alt text](/path/to/image.png). Only reach for <img> or <Frame> if you need attributes markdown can’t express.
• Always include alt text that describes what the image shows, not just “screenshot”.
• Paths are absolute from the site root, starting with /. e.g. /images/help/Highlights-hero.png.
• Storage: images live in /images/<section>/ (e.g. /images/help-hero/) or alongside the .mdx in their feature folder. Group images for a single feature together.
• Filenames: descriptive, no spaces. PascalCase or kebab-case both occur; match what’s already in the folder.

​

Videos

• Short, inline demos: native HTML <video> tag, autoplay loop muted. Hosted on Contentful.
  <video autoPlay muted loop playsInline className="w-full" src="https://videos.ctfassets.net/8fl1jrx919na/.../filename.mp4" />
  
• Longer walkthroughs: YouTube <iframe> so the viewer gets controls.
  <iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/..." title="..." />
  
• Don’t mix the two for the same clip.

​

Frontmatter

---
title: "Channels"
sidebarTitle: "Channels"  # optional, only if different from title
og:image: "/images/help-hero/channels.png"
og:description: "One-line description for social previews."
---

​

File and folder structure

• help/<feature-name>/index.mdx — one folder per help topic. Flat namespace; don’t nest deeply.
• academy/<course-slug>.mdx — flat list of academy lessons at the root of academy/.
• images/ — shared image library, organized by section.
• docs.json — sidebar navigation. Touch carefully. When you add a page, add a corresponding entry in docs.json so it appears in the nav. The path format is the file path minus .mdx (e.g. help/projects/index).
• integrations/ — per-integration .mdx pages.

​

Linking

• Internal links: absolute paths from the site root, no .mdx extension. e.g. [Projects](/help/projects).
• External links to Dovetail product/marketing: full https://dovetail.com/... URLs.
• “Learn more →” is the house phrase for trailing CTA links inside callouts and at the end of sections. Use the actual arrow character →, not ->.

​

Common patterns to follow

• Open feature docs with a one-paragraph framing of the problem the feature solves, then a hero image or video.
• Use scoped mental models explicitly when a feature has multiple levels (e.g. “Workspace — the broadest scope…”, “Project — …”, “Data object — …”).
• End feature pages with a “Where to next” <CardGroup> linking to related features.
• Prerequisites or permission notes go in an <Info> callout at the top of the page, not buried in prose.

​

Things to avoid

• Don’t write H1s — Mintlify generates them from the title frontmatter field.
• Don’t link to a help page using its full dovetail.com/help/... URL from inside the docs site; use the internal path.
• Don’t leave empty Mintlify components in the file (e.g. <AccordionGroup></AccordionGroup> with nothing inside).
• Don’t add a trailing newline-only paragraph or extra blank lines between sections beyond a single blank line.
• Don’t invent new component names or pass props Mintlify doesn’t support.

​

Working locally

• mint dev — local preview (requires npm i -g mint).
• mint broken-links — check for broken links before opening a PR.
• There are no PR preview links; ship small, revert if needed.