Skip to content

Fix style inconsistencies across docs#717

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/style-consistency-1777851807
Open

Fix style inconsistencies across docs#717
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/style-consistency-1777851807

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 3, 2026

Summary

Tightens voice and tone consistency across the docs. The set was already mostly clean — second person and sentence-case headings throughout — but a handful of small deviations slipped in. This PR fixes them without touching technical content.

Changes

  • configuration/bot-settings.mdx — Lowercase # Bot settings H1 to match the sentence-case norm used in every other page (# Getting started, # Security & privacy, etc.).
  • configuration/permissions.mdx — Convert passive "after the dashboard process is restarted" to active "after you restart the dashboard process".
  • features/moderation.mdx — Align bullet term **Auto-mod** with the form already used elsewhere in the same file (table label, body text).
  • features/moderation.mdx — Split two run-on sentences (35 and ~55 words) into shorter, easier-to-scan ones. No meaning lost.

What I left alone

  • # Temp Roles, # Audit Log — Title-case but match the dashboard sidebar labels; reads as proper feature names.
  • Changelog terseness, frontmatter casing, and Mintlify component title= props — intentional and consistent within their own conventions.
  • Anything ambiguous between "intentional choice" and "style drift".

Generated-By: mintlify-agent
Copilot AI review requested due to automatic review settings May 3, 2026 23:44
@mintlify mintlify Bot review requested due to automatic review settings May 3, 2026 23:44
@github-project-automation github-project-automation Bot moved this to Backlog in Volvox.Bot May 3, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 3, 2026

⚠️ No Changeset found

Latest commit: cd35ac4

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

@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:44 PM

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 3, 2026

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 3, 2026

Greptile Summary

Documentation-only PR that applies sentence-case and voice consistency fixes across three .mdx files. No technical content, code, or configuration is modified — all changes are purely prose style.

Confidence Score: 5/5

Safe to merge — documentation-only changes with no functional impact

All three files contain only prose edits (heading case, active/passive voice, sentence splitting, term alignment). No code, logic, schema, or configuration is touched.

No files require special attention

Important Files Changed

Filename Overview
docs/configuration/bot-settings.mdx H1 heading lowercased from "Bot Settings" to "Bot settings" for sentence-case consistency — clean, no issues
docs/configuration/permissions.mdx Passive voice converted to active ("after you restart the dashboard process") — accurate and cleaner
docs/features/moderation.mdx "Auto-moderation" aligned to "Auto-mod"; two run-on sentences split; "or" changed to "and" in the global enforcement listing — all changes preserve meaning

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[PR #717 — Style Fixes] --> B[bot-settings.mdx]
    A --> C[permissions.mdx]
    A --> D[moderation.mdx]
    B --> B1["H1: 'Bot Settings' → 'Bot settings'\n(sentence-case)"]
    C --> C1["Passive → Active voice\n'after you restart the dashboard process'"]
    D --> D1["'Auto-moderation' → 'Auto-mod'\n(term alignment)"]
    D --> D2["Split run-on sentences\n(2 instances)"]
Loading

Reviews (1): Last reviewed commit: "Fix style inconsistencies across docs" | Re-trigger Greptile

@coveralls
Copy link
Copy Markdown

Coverage Status

coverage: 90.193% (+0.007%) from 90.186% — mintlify/style-consistency-1777851807 into main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

1 participant