Standardize voice and tone across docs#707
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
|
| 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
Reviews (7): Last reviewed commit: "docs: clarify triage model fallback word..." | Re-trigger Greptile
9e55ed2 to
1476301
Compare
There was a problem hiding this comment.
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…”). |
1476301 to
48ee2f6
Compare
48ee2f6 to
b5bcab2
Compare
4eebb3a to
a838232
Compare
|
| | 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 | |
|
|
||
| <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. |
| 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.' |
| - **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 |



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 Xframing with the corpus-wideyou/yourvoice. Standardized toyour members/youin:features/tickets.mdxfeatures/community.mdxfeatures/ai-conversations.mdxPassive → 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.mdxkeeps the documented/community/{guildId}placeholder, matching implementation naming.Tests
tests/docs/docs.test.jsnow expects the existing sentence-case headings indocs/manual-test-plan.mdx.Not changed (intentionally)
security.mdxfirst-person plural ("We…") — appropriate for a privacy pagechangelog.mdx— historical release notes left untouchedValidation
pnpm vitest run tests/docs/docs.test.js— passedpnpm lint— passedgit diff --check— passed