docs: sentence case headings and small accuracy fixes#111
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
docs: sentence case headings and small accuracy fixes#111mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
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
Documentation cleanup pass enforcing the project style guide and correcting a few small inaccuracies.
Style fixes (sentence case for all headings)
Per
docs/AGENTS.md, headings must use sentence case. Updated headings across:concepts/providers.mdx,concepts/models.mdx,concepts/messages.mdx,concepts/configuration.mdx,concepts/error-handling.mdxapi/core/errors.mdx,api/core/embed.mdx,api/core/define-tool.mdx,api/core/generate-image.mdxchat-completion,streaming,structured-outputs,tool-calling,embeddings,image-generation,multi-modal)examples/overview.mdxUpdated
<Card>titles within those pages to match.Accuracy fixes
api/core/errors.mdx—namewas incorrectly documented as always'CoreAIError'. Each subclass overridesname; updated the description.api/core/define-tool.mdx— Two examples used Zod 3z.record(z.unknown())syntax. The library requires Zod 4 (perinstallation.mdx), which usesz.record(z.string(), z.unknown()).installation.mdx— OpenAI install Note now lists tool calling, vision, and reasoning to match the other provider Notes.concepts/providers.mdx— Removed the misleading "// Optional: defaults to OPENAI_API_KEY env var" inline comment on a snippet that already passesprocess.env.OPENAI_API_KEYexplicitly. Replaced with a short clarifying sentence.Validation
mint validatepassesmint broken-linksreports no broken links