Repository navigation
docs: build scylla-3.11.5.x and scylla-4.19.2.x with MyST - #1156
Merged
Merged
Conversation
MyST resolves links against the staged tree, where every README.md is index.md, so `../configuration/` renders as a dead `#../configuration/` fragment. Rewrite directory and README.md targets to index.md (index.rst where the target is rST) before parsing. Recommonmark versions and the sources are unchanged. Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
Both now only fast-forward from scylla-3.x and scylla-4.x, whose manuals
use `{eval-rst}` toctrees. Recommonmark renders those as code blocks, so
both versions publish with no navigation.
Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
|
Warning Review limit reachedNext included review available in 55 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: QUIET Plan: Advanced Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This was referenced Sep 28, 2026
nikagra
marked this pull request as ready for review
September 28, 2026 13:48
dkropachev
approved these changes
Sep 28, 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
2 participants
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.
Depends on: nothing
Blocks: nothing; fixes the live navigation of
/stable/and/scylla-3.11.5.x/as soon as it publishesscylla-3.11.5.xandscylla-4.19.2.xnow only fast-forward fromscylla-3.xandscylla-4.x, whose manuals use MyST{eval-rst}toctrees. This branch'sconf.pystill builds both with recommonmark, which renders every toctree as a code block, so both versions are live with no navigation. Every version is built with this branch'sconf.py, so this is the one place to switch them.README.mdso they point atindex.md(orindex.rstfor an rST target) before MyST parses a page; MyST resolves links against the staged tree, where every README.md is index.mdscylla-3.11.5.xandscylla-4.19.2.xwith MySTVerified:
make -C docs test(-W) on this branch: 0 warnings. A link check of the output: 12260 in-body links resolve, 3 dead fragments remain (docs: MyST renders every in-body relative link as a dead fragment #1132 counted 390). The 3 are source bugs: two links to the deleteddse/pages, andnetty_pipeline/instead of../netty_pipeline/indeveloper/request_executionconf.py,scylla-3.11.5.x=scylla-3.x+ ci: publish docs from scylla-3.x with the default branch's workflow #1155 + docs: add a connectivity section to the 3.x manual #1150, andscylla-4.19.2.x=scylla-4.x+ docs: fix ScyllaDB Cloud TLS and client routes details #1151 + docs: name the client_routes spellings on the client routes page #1139: exit 0, javadoc guard green,api/in every version, no toctree rendered as code, the connectivity pages in both MyST versions. In-body links: 2858 resolve in 3.11.5.x and 12107 in 4.19.2.x, with 2 and 3 dead ones left. The 3.x ones are also source bugs: a root-absolute/upgrade_guide/inREADME.md, andmetadata/for../metadata/inmanual/serverless. The recommonmark versions build as beforeNot covered: links whose anchor misses its target (such as
#Jacksonagainst thejacksonid). The recommonmark versions have the same 17, so they come from the sources.Fixes #1132
🤖 Generated with Claude Code