Enforce your style guide: format inline code in LangChain example - #333
Open
mintlify[bot] wants to merge 19 commits into
Open
mintlify[bot] wants to merge 19 commits into
mintlify[bot] wants to merge 19 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This branch was successfully deployed
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
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
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 spellingother-topics/audit-log.mdx(from docs: add the audit log page #342): frontmatter em dash → colon (quoted for YAML), two passive sentences made activev4/examples/langchain-langsmith.mdx: inline code formatting forbind_tools,book_slot,eventTypeId,chat_history,RunnableWithMessageHistory(),predictpartner-services/deepgram.mdx,endpoints/*,hardware/*,security.mdx, and others already consistentskill.md: intentionally untouched; vendored from cerebrium-skills and exempt per CLAUDE.mdContext
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.