Skip to content

Enforce your style guide: format inline code in LangChain example - #333

Open
mintlify[bot] wants to merge 19 commits into
masterfrom
mintlify/d5984721
Open

mintlify[bot] wants to merge 19 commits into
masterfrom
mintlify/d5984721

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Style-consistency passes across the docs: scoped fixes on pages touched by recent PRs (#332, #335, #336, #340, #342, #343, #346) plus a repo-wide pass aligning all MDX pages with the CLAUDE.md voice rules.

Changes

  • Repo-wide pass (24 files): removed banned first-person ("we"/"our" → "Cerebrium"/"the"), dropped filler and hedging ("please", "you'll need to", "You can sign up" → imperatives), converted clear passive voice to active, split em-dash clause joiners and 30+ word sentences, and normalized "choose" → "select" for UI options
  • performance/checkpointing.mdx: em-dash/long-sentence/app-ID/passive-voice fixes on content from docs: explain why a checkpoint failed and how to fix it #335, docs: document checkpoint size and restore duration #336, Name the two runtime checkpoint failures the agent now reports #343, and Document why a checkpointed app can still cold start #346 (latest: "Nothing is logged when a restore is skipped" → "The runtime logs nothing when it skips a restore"); repaired the heading-anchor MDX comment that the Prettier bot keeps mangling into {/_ … _/}, which fails MDX parsing (repaired four times on this branch — the Prettier config needs to exclude this file or the comment replaced with something Prettier-safe)
  • toml-reference/toml-reference.mdx (from Update the init timeout ceiling to 7200 in the TOML reference #340): "initialisation" → "initialization", matching the parameter name and repo-wide American spelling
  • other-topics/audit-log.mdx (from docs: add the audit log page #342): frontmatter em dash → colon (quoted for YAML), two passive sentences made active
  • v4/examples/langchain-langsmith.mdx: inline code formatting for bind_tools, book_slot, eventTypeId, chat_history, RunnableWithMessageHistory(), predict
  • Reviewed with no changes needed: partner-services/deepgram.mdx, endpoints/*, hardware/*, security.mdx, and others already consistent
  • skill.md: intentionally untouched; vendored from cerebrium-skills and exempt per CLAUDE.md

Context

No code blocks, headings, anchors, links, or technical content changed. The checkpoint agent deep-links to checkpointing headings by anchor; all preserved. Build validation passes.

@mintlify
mintlify Bot requested review from kylegani and milo157 as code owners August 28, 2026 00:33
@mintlify

mintlify Bot commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated
cerebrium 🟢 Ready View Preview Sep 15, 2026, 5:13 PM

@mintlify
mintlify Bot requested a review from jonoirwinrsa September 11, 2026 16:43

This branch was successfully deployed

1 active (outdated) deployment
staging — 1eff75ba Deployed Sep 15, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants