Fix writing style and tone inconsistencies#2466
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
- Fix sentence case in page titles: Scoring Overview, Tools & Utilities, Manage Weave Projects, TypeScript SDK integration guide, API Overview, Enterprise Licenses - Convert passive voice to active voice in training section pages - Replace gerund headings with imperative verbs in costs.mdx - Fix typos: exterrnal, posses, organzation's, the your companies, inper - Remove duplicate Available Endpoints section in api-reference.mdx - Replace Latin abbreviation (e.g.) with plain English - Remove exclamation points per style guide Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
📚 Mintlify Preview Links📝 Changed (17 total)📄 Pages (17)
🤖 Generated automatically when Mintlify deployment succeeds |
Contributor
🔗 Link Checker Results✅ All links are valid! No broken links were detected. Checked against: https://wb-21fd5541-mintlify-style-consistency-1776283399.mintlify.app |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes style inconsistencies found during a docs-wide audit for voice, tone, and formatting consistency.
Changes
Heading capitalization (title case → sentence case):
weave/guides/evaluation/scorers.mdx: "Scoring Overview" → "Scoring overview"weave/guides/tools.mdx: "Tools & Utilities" → "Tools and utilities"weave/guides/platform/weave-projects.mdx: "Manage Weave Projects" → "Manage Weave projects"weave/guides/integrations/js.mdx: "TypeScript SDK: Third-Party Integration Guide" → "TypeScript SDK: third-party integration guide"training/api-reference.mdx: "API Overview" → "API overview"platform/hosting/enterprise-licenses.mdx: "Enterprise Licenses" → "Enterprise licenses"Gerund headings → imperative verbs in
weave/guides/tracking/costs.mdx:Passive voice → active voice across training section:
Typos fixed:
Other style fixes: