docs: update theme 1.9.3 - #977
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThe configuration reference README now links to the configuration index with a Sphinx Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@manual/core/configuration/reference/README.rst`:
- Line 27: Update the configuration cross-reference in the README documentation
to target the existing /manual/core/configuration/README document instead of the
nonexistent configuration index target, preserving the surrounding explanatory
link text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 386b0682-db1b-44d1-ac3a-66fcc27e2694
⛔ Files ignored due to path filters (1)
docs/uv.lockis excluded by!**/*.lock
📒 Files selected for processing (2)
docs/pyproject.tomlmanual/core/configuration/reference/README.rst
| ``core/src/main/resources``). | ||
|
|
||
| See the `configuration page <../>`_ for more explanations. | ||
| See the :doc:`configuration page </manual/core/configuration/index>` for more explanations. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
fd -HI '^(README\.md|index\.(rst|md))$' manual/core/configuration
rg -n 'source_suffix|master_doc|root_doc|manual/core/configuration' docs manual -g '*.py' -g '*.toml' -g '*.rst'Repository: scylladb/java-driver
Length of output: 438
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "== repository layout around configuration docs =="
git ls-files 'manual/core/configuration/*' 'docs/source/conf.py' 'mkdocs.yml' '*.yml' '*.yaml' '*.toml' | sed -n '1,200p'
echo
echo "== docs/source/conf.py relevant settings =="
sed -n '1,120p' docs/source/conf.py
echo
echo "== Sphinx autodoc/setup / include manifests mentioning manual/core/configuration =="
rg -n 'manual/core/configuration|configuration/reference|Sphinx|sphinx|toctree|include|conf\.py' -g '*.py' -g '*.rst' -g '*.yml' -g '*.yaml' -g '*.toml' -g '*.cfg' docs manual .github 2>/dev/null | sed -n '1,240p'
echo
echo "== Markdown doc title/heading if present =="
sed -n '1,80p' manual/core/configuration/README.mdRepository: scylladb/java-driver
Length of output: 9121
Point the configuration cross-reference at the actual doc file.
manual/core/configuration/README.md exists, but there is no manual/core/configuration/index document or corresponding Sphinx alias. This :doc: reference should target </manual/core/configuration/README> so it doesn’t become an unresolved “missing reference” warning.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@manual/core/configuration/reference/README.rst` at line 27, Update the
configuration cross-reference in the README documentation to target the existing
/manual/core/configuration/README document instead of the nonexistent
configuration index target, preserving the surrounding explanatory link text.
|
@nikagra @dkropachev Please merge. |
4f82a90 to
88bb979
Compare
|
@nikagra rebased |
Replaces #961
Updates docs theme to the latest version.