Skip to content

Standardize voice and tone across docs#707

Merged
BillChirico merged 6 commits intomainfrom
mintlify/style-consistency-1777809122
May 3, 2026
Merged

Standardize voice and tone across docs#707
BillChirico merged 6 commits intomainfrom
mintlify/style-consistency-1777809122

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 3, 2026

Summary

Audit of writing style across docs and related docs tests. The docs already use sentence-case headings; this PR keeps that convention and aligns stale docs-test expectations with the existing headings.

Voice consistency (third person → second person)

Feature docs mixed Members do X framing with the corpus-wide you/your voice. Standardized to your members / you in:

  • features/tickets.mdx
  • features/community.mdx
  • features/ai-conversations.mdx

Passive → active voice

Replaced passive constructions where there is a clear subject (the bot, the dashboard, you):

  • features/tickets.mdx — "transcripts saved when tickets are closed" → "the bot saves a transcript when a ticket closes"; "A private channel is created" → "The bot creates a private thread or channel"; ticket configuration wording now matches the current single category / single support role implementation.
  • features/temp-roles.mdx — "Roles are removed on schedule" → "The bot removes roles on schedule"; "The role is assigned immediately and will be removed automatically" → "The bot assigns the role immediately and removes it automatically"
  • features/moderation.mdx — "can be configured from the dashboard" → "you can configure it from the dashboard"; "Where moderation actions are posted" → "Where the bot posts moderation actions"; AI moderation and triage wording now matches the supported-model fallback behavior.
  • features/audit-log.mdx — "Every action Volvox.Bot takes is recorded in the audit log" → "Volvox.Bot records every action it takes in the audit log"
  • features/community.mdx — "Public profiles are accessible at" → "View public profiles at"
  • configuration/bot-settings.mdx — "Every setting is editable" / "Changes are saved and applied" → "You can edit every setting" / "The dashboard saves and applies changes"
  • configuration/permissions.mdx — "Dashboard access is controlled by Discord roles" → "Discord roles control dashboard access"

Terminology

  • help.mdx — "other users" → "other members" to match the corpus-wide use of "members"
  • community.mdx keeps the documented /community/{guildId} placeholder, matching implementation naming.

Tests

  • tests/docs/docs.test.js now expects the existing sentence-case headings in docs/manual-test-plan.mdx.

Not changed (intentionally)

  • Code samples, config keys, and API references
  • security.mdx first-person plural ("We…") — appropriate for a privacy page
  • changelog.mdx — historical release notes left untouched
  • Long sentences in changelog entries (release-note style is acceptable)

Validation

  • pnpm vitest run tests/docs/docs.test.js — passed
  • pnpm lint — passed
  • git diff --check — passed
  • Mintlify CLI validation — skipped locally; CLI is not installed in this worktree

@mintlify mintlify Bot requested review from Copilot and removed request for Copilot May 3, 2026 11:54
@github-project-automation github-project-automation Bot moved this to Backlog in Volvox.Bot May 3, 2026
@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 3, 2026

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

Project Status Preview Updated (UTC)
volvox 🟢 Ready View Preview May 3, 2026, 11:55 AM

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 3, 2026

⚠️ No Changeset found

Latest commit: 743cd6d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 3, 2026

Greptile Summary

This PR is a documentation-only voice and tone pass across nine .mdx files, converting passive constructions and third-person framing to active voice and second-person (you/your), with matching test expectation updates in tests/docs/docs.test.js. The test changes correctly reflect the existing sentence-case headings already present in docs/manual-test-plan.mdx, and all other wording changes are consistent with the stated goals in the PR description.

Confidence Score: 5/5

Documentation-only PR with no code changes; safe to merge.

All changes are prose rewording in MDX files and test string updates. No logic, schema, or security-relevant code is modified. Test expectations were verified against the actual file content.

No files require special attention.

Important Files Changed

Filename Overview
docs/configuration/bot-settings.mdx Minor active-voice reword: "Every setting is editable" → "You can edit every setting"; no semantic change.
docs/configuration/permissions.mdx Adds the article "the" before "Manage Server" permission for grammatical accuracy; no semantic change.
docs/features/ai-conversations.mdx Voice consistency pass: "Members" → "Your members", "Choose the AI model" → "The AI model to use"; no semantic change.
docs/features/audit-log.mdx Active-voice reword: "Every action … is recorded" → "Volvox.Bot records every action it takes"; no semantic change.
docs/features/community.mdx Voice consistency pass plus URL update from {serverId} to {guildId} and adds explicit https:// scheme; placeholder name change was previously flagged.
docs/features/moderation.mdx Active-voice and triage fallback behaviour description updates; semantic accuracy concern with fallback wording was flagged in a previous thread.
docs/features/temp-roles.mdx Minor active-voice rewording ("removes itself" → "the bot removes", "no manual tracking" → "with no manual tracking"); no semantic change.
docs/features/tickets.mdx Voice pass plus schema alignment: "Ticket categories" → "Ticket category", "Staff roles" → "Support role", tip callout updated to match single-category/single-role implementation.
docs/help.mdx Single-word terminology change: "other users" → "other members" to match corpus-wide term.
tests/docs/docs.test.js Updates two test expectations to sentence-case headings ("Manual test plan", "Publish to GitHub wiki"), correctly matching existing headings in manual-test-plan.mdx.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[PR #707: Standardize voice and tone] --> B[Feature docs\ntickets · community · ai-conversations\naudit-log · moderation · temp-roles]
    A --> C[Config docs\nbot-settings · permissions]
    A --> D[help.mdx]
    A --> E[tests/docs/docs.test.js]

    B --> F[Passive → Active voice\nThird person → Second person]
    C --> F
    D --> G[users → members]
    E --> H[Test expectations updated\nto match sentence-case headings\nin manual-test-plan.mdx]

    F --> I[No semantic changes]
    G --> I
    H --> I
Loading

Reviews (7): Last reviewed commit: "docs: clarify triage model fallback word..." | Re-trigger Greptile

@BillChirico BillChirico force-pushed the mintlify/style-consistency-1777809122 branch from 9e55ed2 to 1476301 Compare May 3, 2026 12:47
Copilot AI review requested due to automatic review settings May 3, 2026 12:47
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Standardizes the voice/tone across Mintlify documentation in docs/ to consistently use second person (“you/your”) and active voice when describing bot/dashboard behavior.

Changes:

  • Rewrites feature docs to use second-person phrasing (e.g., “your members…”, “you can…”).
  • Converts passive voice to active voice with explicit subjects (the bot, the dashboard, you).
  • Aligns terminology (“members” vs “users”) for consistency across the docs corpus.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/help.mdx Replaces “other users” with “other members” for consistent terminology.
docs/features/tickets.mdx Updates ticket feature copy to second person + active voice (“The bot creates…”, “The bot saves…”).
docs/features/temp-roles.mdx Rephrases temp role behavior in active voice (“The bot removes…”, “The bot assigns…”).
docs/features/moderation.mdx Shifts moderation docs to second person + active voice, clarifying who performs actions.
docs/features/community.mdx Updates community feature descriptions to second person and more direct phrasing.
docs/features/audit-log.mdx Converts opening sentence to active voice (“Volvox.Bot records…”).
docs/features/ai-conversations.mdx Updates AI chat doc copy to second person and explicit bot actions (logging/management).
docs/configuration/permissions.mdx Rephrases dashboard access control in active voice (“Discord roles control…”).
docs/configuration/bot-settings.mdx Rephrases configuration explanation to second person + active voice (“You can…”, “The dashboard saves…”).

Comment thread docs/features/moderation.mdx Outdated
@BillChirico BillChirico force-pushed the mintlify/style-consistency-1777809122 branch from 1476301 to 48ee2f6 Compare May 3, 2026 12:52
@BillChirico BillChirico force-pushed the mintlify/style-consistency-1777809122 branch from 48ee2f6 to b5bcab2 Compare May 3, 2026 13:51
Copilot AI review requested due to automatic review settings May 3, 2026 13:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Comment thread docs/features/community.mdx Outdated
Comment thread docs/features/moderation.mdx Outdated
Comment thread docs/features/tickets.mdx Outdated
@coveralls
Copy link
Copy Markdown

coveralls commented May 3, 2026

Coverage Status

Coverage is 90.19%mintlify/style-consistency-1777809122 into main. No base build found for main.

Comment thread docs/features/moderation.mdx Outdated
Comment thread docs/features/community.mdx
Copilot AI review requested due to automatic review settings May 3, 2026 23:24
@BillChirico BillChirico force-pushed the mintlify/style-consistency-1777809122 branch from 4eebb3a to a838232 Compare May 3, 2026 23:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Comment thread docs/features/moderation.mdx Outdated
Comment thread tests/docs/docs.test.js
Comment thread docs/features/tickets.mdx
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 3, 2026

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Comment thread docs/features/tickets.mdx
Comment on lines +33 to +37
| Ticket category | Root category where the bot creates ticket channels |
| Auto-close | Automatically close stale tickets after N hours |
| Transcript channel | Where transcripts are posted |
| Staff roles | Which roles can see and manage tickets |
| Welcome message | Auto-sent when a ticket is opened |
| Transcript channel | Where the bot posts transcripts |
| Support role | Which role can see and manage tickets |
| Welcome message | The message the bot sends automatically when a ticket opens |
Comment thread docs/features/tickets.mdx

<Callout type="tip">
Set up multiple categories so the bot routes tickets to the right team automatically.
Choose the ticket category and support role so new tickets land where your team expects.
Comment thread docs/features/tickets.mdx
title: Discord Support Tickets and Transcripts
sidebarTitle: Tickets
description: 'Run a Discord support ticket system with Volvox.Bot — ticket panels, multi-category routing, private channels, automatic transcripts, and dashboard tools.'
description: 'Run a Discord support ticket system with Volvox.Bot — ticket panels, a root category, private channels, automatic transcripts, and dashboard tools.'
Comment thread docs/features/tickets.mdx
Comment on lines +13 to +15
- **Ticket creation** — Your members open tickets via a panel or command
- **Ticket location** — Create ticket channels under one configured category
- **Transcripts** — The bot saves a transcript automatically when a ticket closes
@BillChirico BillChirico merged commit aa3d457 into main May 3, 2026
26 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in Volvox.Bot May 3, 2026
@BillChirico BillChirico deleted the mintlify/style-consistency-1777809122 branch May 3, 2026 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants