Repository navigation
Restore the stellar-cli docs check for Mintlify - #3105
Merged
Merged
Conversation
Re-add build.yml as a workflow_call target so stellar-cli's docs.yml can validate its help docs and cookbook again. Update stellar_cli.mjs for the Mintlify tree (no src/helpers, title front matter, no duplicate H1), exclude the temporary stellar-cli clone from mint, and drop the Docusaurus link fixer.
Replace the full clone (and fetch of every PR merge ref) with a shallow, blob-filtered fetch of the requested ref and a sparse checkout of cookbook/ and FULL_HELP_DOCS.md. Resolve the latest release tag with ls-remote, and keep accepting pr/<n>/merge refs.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ElliotFriend
added a commit
to ElliotFriend/stellar-cli
that referenced
this pull request
Nov 10, 2026
This was referenced Nov 10, 2026
ElliotFriend
commented
Nov 10, 2026
Called from another repo, actions/checkout defaults to the default branch, so a caller testing a stellar-docs branch ran main's scripts. Also fix the header comment left stale by the rename.
ElliotFriend
commented
Nov 10, 2026
The workflow is only called from stellar-cli. A dispatch trigger lets it run in the default branch's cache scope, which CodeQL flags as cache poisoning.
It was only needed to test a stellar-docs branch from stellar-cli before merge. Callers use cli-build.yml@main, where the default-branch checkout already matches.
ElliotFriend
requested review from
fnando,
kaankacar and
leighmcculloch
and removed request for
kaankacar
November 11, 2026 16:15
leighmcculloch
approved these changes
Nov 11, 2026
…ator Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
leighmcculloch
pushed a commit
to stellar/stellar-cli
that referenced
this pull request
Nov 11, 2026
### What - Converts `cookbook/*.mdx` from Docusaurus to Mintlify syntax: admonitions become `<Note>`, `<Tip>`, `<Info>`, and `<Danger>` callouts, Docusaurus-only frontmatter keys are removed, and relative `.mdx` links become root-relative paths. - Changes the bare `cookbooktest.ignore` and `cookbooktest.fail` fence flags to `cookbooktest.ignore=""` and `cookbooktest.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. - Points `docs.yml` at stellar-docs' new `cli-build.yml` workflow (stellar/stellar-docs#3105). - Regenerates `FULL_HELP_DOCS.md`, which was out of date on `main` and 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 the `build.yml` that `docs.yml` called, so "Docs validation" has failed on every run since. ### Known limitations - `release/**` branches still call the removed `build.yml`, so their docs check keeps failing until this change reaches them. - The cookbook integration tests weren't run locally, because they need a local network.
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
.github/workflows/cli-build.yml, a reusable workflow that replaces thebuild.ymlthe migration removed. Given astellar-cli-ref, it syncs the CLI help docs and cookbook, runsmint validate, and reportsmint broken-linkswithout failing.scripts/stellar_cli.mjsfor Mintlify: it no longer writes to the deletedsrc/(the script crashed), it writestitlefrontmatter instead ofsidebar_position, and it fetches onlycookbook/andFULL_HELP_DOCS.mdat the requested commit.scripts/stellar_cli_plugins.mjsfrom writingsidebar_position, which Mintlify ignores./stellar-cli-repo/clone to.mintignore, somint validateskips it.scripts/fix_cli_links.sh, which rewrote links to the Docusaurus style.Why
stellar-cli's
docs.ymlstill callsbuild.yml@main, so its "Docs validation" check has failed on every run since #2941. stellar/stellar-cli#2888 switches it tocli-build.yml.Known limitations
build.yml, so their check keeps failing.The sync ran locally against a tag,
main, a SHA, a release branch, and PR merge refs, andmint validatepasses afterward. stellar/stellar-cli#2888 currently runs this workflow from this branch. After this merges, point it back at@main.🤖 Generated with Claude Code