Repository navigation
fix(docs): Update the cookbook and docs check for Mintlify - #2888
Merged
leighmcculloch merged 7 commits intoNov 11, 2026
Merged
Conversation
Replace admonitions with callouts, drop Docusaurus-only front matter, and make developers.stellar.org links root-relative. Give bare cookbooktest flags an empty quoted value so Mintlify does not render them as codeblock titles.
Revert before merging.
This was referenced Nov 10, 2026
Revert before merging, along with 4df05e1.
ElliotFriend
changed the title
leighmcculloch
approved these changes
Nov 11, 2026
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.
What
cookbook/*.mdxfrom Docusaurus to Mintlify syntax: admonitions become<Note>,<Tip>,<Info>, and<Danger>callouts, Docusaurus-only frontmatter keys are removed, and relative.mdxlinks become root-relative paths.cookbooktest.ignoreandcookbooktest.failfence flags tocookbooktest.ignore=""andcookbooktest.fail="". Mintlify showed the bare flags as code block titles. The test harness only checks that the keys are present, so tests behave the same.docs.ymlat stellar-docs' newcli-build.ymlworkflow (Restore the stellar-cli docs check for Mintlify stellar-docs#3105).FULL_HELP_DOCS.md, which was out of date onmainand failing the pre-commit hook.Why
developers.stellar.org moved to Mintlify, and stellar-docs copies
cookbook/onto the site as is. The migration also removed thebuild.ymlthatdocs.ymlcalled, so "Docs validation" has failed on every run since.Known limitations
release/**branches still call the removedbuild.yml, so their docs check keeps failing until this change reaches them.