-
Notifications
You must be signed in to change notification settings - Fork 1
Update to crate-docs-theme>=0.40.0.dev0
#266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Warning Rate limit exceeded@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 7 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (3)
WalkthroughBump docs dependency and update documentation pages: Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/requirements.txt (1)
1-1
: Pre-release floor may cause non-reproducible installs; consider pinning or bounding the range.Using
crate-docs-theme>=0.40.0.dev0
opts into pre-releases and allows upgrades to any newer dev/pre/final, which can drift CI builds. Prefer either:
- Pin exactly to the intended dev cut for reproducibility, or
- Bound within the 0.40.x line to avoid unexpected 0.41+ changes.
Two options:
- crate-docs-theme>=0.40.0.dev0 + crate-docs-theme==0.40.0.dev0or (stay on 0.40 train, accept newer dev/finals only within 0.40):
- crate-docs-theme>=0.40.0.dev0 + crate-docs-theme>=0.40.0.dev0,<0.41.0.dev0
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/requirements.txt
(1 hunks)
🔇 Additional comments (1)
docs/requirements.txt (1)
1-1
: Pre-release verified and pip resolution confirmed
- The crate-docs-theme 0.40.0.dev0 pre-release is published on PyPI.
- The latest final release is 0.39.0.
- Running
pip download "crate-docs-theme>=0.40.0.dev0"
successfully fetched the 0.40.0.dev0 wheel, confirming that CI will install this dev release when resolving the spec.If targeting the dev build is intentional, no further changes are needed. Otherwise, consider pinning to the latest final version (0.39.0) or adjusting your version spec.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/admin/create-user.md (1)
23-24
: Consider unifying link style for external references (optional).The page mixes
{ref}
with[](inv:...)
. Both are valid in MyST; choosing one consistently can reduce maintenance overhead. Given lines 28–31 useinv:
links, you could switch lines 23–24 to the same style for consistency—or conversely migrate theinv:
links to{ref}
if all targets resolve via intersphinx.Example using
inv:
style here:-... first {ref}`install Crash <crate-crash:getting-started>` or {ref}`connect <connect>` ... +... first [](inv:crate-crash:getting-started){.xref title="install Crash"} or {ref}`connect <connect>` ...Or convert nearby
inv:
uses to{ref}
if those labels resolve via intersphinx.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/admin/create-user.md
(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-23T04:22:52.562Z
Learnt from: amotl
PR: crate/cratedb-guide#235
File: docs/start/going-further.md:20-38
Timestamp: 2025-08-23T04:22:52.562Z
Learning: In the CrateDB Guide repository, the prefix `crate-reference:` in documentation links (like `crate-reference:index`) is an intersphinx reference that points to external content in the CrateDB Reference Manual documentation. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/admin/create-user.md
📚 Learning: 2025-08-14T19:02:43.308Z
Learnt from: amotl
PR: crate/cratedb-guide#253
File: docs/integrate/mindsdb/index.md:21-33
Timestamp: 2025-08-14T19:02:43.308Z
Learning: In CrateDB integration documentation examples, default connection parameters (user="crate", password="", host="127.0.0.1") are intentionally used to provide working out-of-the-box examples for users with local CrateDB instances, rather than using placeholder values that require customization.
Applied to files:
docs/admin/create-user.md
b543efd
to
7f7cb33
Compare
All content has been absorbed by `cratedb-guide` already.
7f7cb33
to
6e6124a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the .dev0 versioning?
If something is wrong, it will not be too contagious across all the repositories/projects which are pulling that package. |
About
Include a few updates to probe here, for example the phasing-out of
crate-clients-tools
, and a mitigation against recently increased build errors on CI.Preview
https://cratedb-guide--266.org.readthedocs.build/
References
crate-clients-tools
crate-docs-theme#620