Skip to content

Add a voice and tone section to the agent guide - #1532

Merged
jpetey75 merged 1 commit into
mainfrom
jake/ae-1405-voice-and-tone
Oct 22, 2026
Merged

jpetey75 merged 1 commit into
mainfrom
jake/ae-1405-voice-and-tone

Conversation

@jpetey75

Copy link
Copy Markdown
Contributor

Adds a Voice and tone section to .mintlify/AGENTS.md, right after Writing. The guide already covers structure and placement, but it says nothing about how pages should read.

It describes how the best existing pages already read (explore/dashboards.mdx is the model):

  • Address the reader in second person, active voice.
  • Open with what the reader is trying to do.
  • Use imperative, sentence-case headings for tasks.
  • Bold UI labels and write click paths with →.
  • Name exact settings, defaults and roles.
  • Keep numbered steps to one action each.
  • Keep frontmatter descriptions to one line.
  • No prices or roadmap promises.

Why now: Cloudy is getting a docs writer agent that opens PRs here, and it follows this file (lightdash-cloud-announcer, AE-1405). Human contributors and other agents get the same guidance.

🤖 Generated with Claude Code

Agents writing docs, including Cloudy's docs writer (AE-1405), follow
AGENTS.md; it covered structure but not how pages should read.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
lightdash 🟢 Ready View Preview Oct 22, 2026, 3:02 AM

@linear-code

linear-code Bot commented Oct 22, 2026

Copy link
Copy Markdown

AE-1405

@github-actions

Copy link
Copy Markdown
Contributor

Documentation validation

✅ All blocking checks passed.

Component system

0 finding(s) across the corpus.

Findings on lines this pull request touched are annotated inline in Files changed.

View the validation run.

@jpetey75
jpetey75 merged commit e0bd375 into main Oct 22, 2026
7 checks passed
@jpetey75
jpetey75 deleted the jake/ae-1405-voice-and-tone branch October 22, 2026 19:25

This branch was successfully deployed

1 active deployment
staging — 336f5c2d Deployed Oct 22, 2026 by mintlify[bot]
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.

1 participant