Guidance: Curated index to the whole cloud section

[amotl]

About

Having a dedicated "Features" section in a curated way will provide better guidance for exploring the subject matter, for both humans and machines. It is a compressed variant of https://cratedb.com/product/cloud, which is unfortunately gone now.

Preview

• https://crate-cloud--88.org.readthedocs.build/en/88/

Why?

• Improve user guidance on the documentation of the Cloud product.
• People say the Database Features page may have too much gravity.
• This patch explores a few possibilities in content bundling and presenting using visual elements. If you like what you see, maybe fragments of this will resonate with you and spark other ideas how to improve guidance here and there.

Trivia

Such a "all on one page" article also helps to fill gaps in the semantic knowledge backbone.

Problem: This just includes the index, but no content.

See cratedb-outline.yaml, section "CrateDB Cloud"

References

• Emphasizing features of CrateDB Cloud cratedb-guide#137

/cc @surister, @kneth, @ckurze, @geragray, @wmKvXo

[proddata]

I am still unclear about the purpose of the “All Features” pages. They appear to add unnecessary complexity with limited benefits, potentially creating a hurdle in the user experience.

Additionally, this specific patch seems to include outdated screenshots, which might have been taken from other parts of the documentation that also require updating.

[widmogrod]

I read through the changes. Grammatically and visually, they look good.

Refreshed CrateDB Cloud page looks nicer. Indeed, a newer screenshot could be used. But as I understand it, this is not a new asset, so maybe in a separate PR, we could refresh/modernize all images.

As for the All features page, what I found confusing is the duplication of sub-sections:

Is there a way to change it, and have all features more like a landing page that just list them? or maybe it would make more sense to merge All Features with CrateDB Cloud page (I think I like the last option)? @proddata any oppionon about it?

[amotl]

Problem

As for the All features page, what I found confusing is the duplication of sub-sections:
Is there a way to change it, and have all features more like a landing page that just list them?

Solution

• Patch: CrateDB Cloud: Collapse navigation items on feature/index page crate-docs-theme#556
• Preview: https://crate-cloud--88.org.readthedocs.build/en/88/feature/
  

How it is done...

... is certainly quirky, but c'est la vie. It should not block this patch in general now that there is a solution for this obstacle. In the future, those explorations might yield a "programmable" navigation component, that will have a better usability than fiddling with conditionals in Sphinx/Jinja templating. But well, this is not a concern right now.

• Add "link tree" element, using directive linktree tech-writing/sphinx-design-elements#11
• Use Furo's navigation component through sphinx-design-elements' linktree crate-docs-theme#405

Outlook

Maybe it would make more sense to merge All Features with CrateDB Cloud page. I think I like the last option.

This will certainly need more work and probably also discussions. I will be happy to work together with you on a subsequent iteration, maybe later this year. Right now, because I also need to take care about other obligations, I don't have any capacities to iterate.

If you like the ingredients as-is, you may want to either take over the branch and add your improvements on top ¹, or merge it in the current state, in order to add more improvements later.

Footnotes

1. That's also why it's called collab/all-features. ↩

[proddata]

I don’t see much value in this refactor. To me, it still seems to complicate the user journey rather than improve it. If we want to highlight specific features, this should be done on the cloud homepage, not on a separate page. Additionally, we should avoid cluttering the design with numerous logos or images that simply repeat the text.

Thank you for giving it a try; however, I will close this for now until we have a clearer understanding of what we want to achieve and how this change helps users navigate the documentation or better understand the product.

[bmunkholm]

At first glance I tend to agree with other reviewers - I had the exact same questions as @widmogrod mentioned (before reading them). Main point being this seems more of an index to whole cloud section. So it should not have it's own page but be part of the "CrateDB Cloud" page, and not have the pages in the left navbar - they are very confusing as they are not pages.
I would suggest to not focus on this for now and revisit later in case I'm missing the whole point.

[amotl]

Hi Brian,

Main point being this seems more of an index to whole cloud section.

Yes, that's its purpose.

So it should not have it's own page but be part of the "CrateDB Cloud" page, and not have the pages in the left navbar - they are very confusing as they are not pages.

Right, please don't get distracted by those details which are artefacts because things are still in flux but focus on the main idea instead to improve content bundling and presentation, for a better guidance than before, in this case in a "everything important on one page" spirit. This new page effectively just indexes into existing content in order to present it in a different way to encourage discussions -- again, please don't get lost in certain details when evaluating.

I would suggest to not focus on this for now and revisit later in case I'm missing the whole point.

Sure, I think we will touch this topic once more when we start getting our hands dirty by working on the topic together more closely.

With kind regards,
Andreas.

[amotl]

Hi again. Thanks for your feedback again.

As for the All features page, what I found confusing is the duplication of sub-sections:
Is there a way to change it, and have all features more like a landing page that just list them?

Yes, this will certainly need more work.

So it should not have it's own page but be part of the "CrateDB Cloud" page, and not have the pages in the left navbar - they are very confusing as they are not pages.

Right, please don't get distracted by those details [...]

Based on your admonitions about the wrong slotting, I've relocated the content now to the main index page. As such, the navigation artefacts you have been mentioning are gone. Please have a look with a fresh eye.

[coderabbitai]

Warning

Rate limit exceeded

@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between f61dd32 and 6a64506.

📒 Files selected for processing (1)

• docs/index.md (1 hunks)

Walkthrough

Added a new Admin UI note to the cluster console docs and rewrote the docs landing page: replaced the Learn rubric with a toctree, introduced an All Features grid of cards, updated copy/links/icons, added external references, and applied minor layout and CSS adjustments.

Changes

Cohort / File(s)	Summary of Changes
Console docs update docs/cluster/console.md	Inserted a new note about each CrateDB Cloud cluster providing a dedicated Admin UI with a link to the Admin UI index; content added only, no removals or edits to existing text.
Docs landing page overhaul docs/index.md	Replaced prior Learn section with a toctree-based navigation; added an All Features grid of feature cards (reorganized categories, icons, links); revised descriptive copy and item labels (e.g., SQL Console, Ingest, Connect, API CLI); removed a marketing blurb; added external reference links and a compact-list CSS snippet; adjusted grid/layout styling.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Poem

A rabbit skips through docs anew,
Cards and links in tidy view.
Console hums — the Admin's near,
Notes appear, the path is clear.
Hop along, the updates sing, 🥕✨

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch collab/all-features

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (8)

docs/cluster/console.md (1)

32-36: Verify intersphinx mapping for "crate-admin-ui" and align Admin UI naming with "Connect"

Short summary: I found the cross-reference in docs/cluster/console.md but no intersphinx_mapping in the repo; .readthedocs.yml references docs/conf.py (which wasn't found). Please confirm the Sphinx config defines the "crate-admin-ui" intersphinx key or add it, and consider clarifying the label to match the "Connect" umbrella.

Files to check

• docs/cluster/console.md — contains:
  :::{note}
  Each CrateDB Cloud cluster offers a dedicated {ref}Admin UI <crate-admin-ui:index>,
  which can be used to explore data, schema metadata, and cluster status
  information.
  :::
• .readthedocs.yml — references docs/conf.py (ensure docs/conf.py or the active Sphinx config contains an intersphinx_mapping entry with the key "crate-admin-ui").
• CHANGES.rst — mentions intersphinx changes (informational).

Suggested tiny change to avoid user confusion (optional):
:::{note}
Each CrateDB Cloud cluster offers a dedicated {ref}Admin UI <crate-admin-ui:index> (Connect),
which can be used to explore data, schema metadata, and cluster status
information.
:::

docs/index.md (7)

105-123: Copy edits for clarity and correctness.

• “Flexible Deployment: Full-managed vs. hybrid” → “Flexible deployment: fully managed vs. hybrid”
• Consider rephrasing “provides confident scaling of your workloads” to “provides reliable scaling of your workloads”.

Apply:

- - Flexible Deployment: Full-managed vs. hybrid
+ - Flexible deployment: fully managed vs. hybrid
@@
-CrateDB Cloud provides confident scaling of your workloads,
-and deployments on your preferred infrastructure provider.
+CrateDB Cloud provides reliable scaling of your workloads
+and deployments on your preferred infrastructure provider.

---

124-135: Optional: Rename “Confidence” to “Security & Compliance” for clarity.

“Confidence” may be ambiguous for users scanning the page. “Security & Compliance” aligns better with the listed items.

-::::{grid-item-card} {material-outlined}`security;2em` Confidence
+::::{grid-item-card} {material-outlined}`security;2em` Security & Compliance

---

140-151: Tighten copy under Learn.

The sentence is a bit verbose. Consider simplifying.

-If you want to start using CrateDB Cloud, or make the most of your
-existing subscription, we are maintaining resources and tutorials
-to support you correspondingly.
+If you’re getting started with CrateDB Cloud—or want to get more from your
+subscription—we provide resources and tutorials to help.

---

158-169: Align name with toctree entry.

This card says “API CLI” while the toctree uses “Croud CLI”. Use one consistently.

If you want “API CLI” everywhere:

-How Tos <howtos/index>
-Croud CLI <tutorials/deploy/croud>
+How-tos <howtos/index>
+API CLI <tutorials/deploy/croud>

And optionally update the card title to “API CLI (croud)” if you want to retain the product name:

-:::{grid-item-card} {octicon}`terminal` API CLI
+:::{grid-item-card} {octicon}`terminal` API CLI (croud)

---

191-195: Minor: keep tool naming consistent with new “Connect” umbrella.

If “Connect” is the canonical entry point, consider referencing it here and ensuring “Admin UI” vs “Connect” naming is harmonized across pages.

-Learn about key database drivers and client applications for CrateDB,
-such as CrateDB Admin UI, crash, psql, DataGrip, and DBeaver.
+Learn about key database drivers and client applications for CrateDB,
+such as the Admin UI, crash, psql, DataGrip, and DBeaver.

---

226-245: Remove or use unused reference definitions to satisfy MD053.

markdownlint flagged several unused link reference definitions (e.g., CrateDB, Croud CLI, How-To Guides, Reference, Auditing, CCPA, Encryption, GDPR, HIPAA, ISO 27001, RBAC, SOC 2 Type 2). Either reference them in content (e.g., a “See also” section) or remove them.

Minimal removal (only those flagged as unused):

-[CrateDB]: https://crate.io/product/
-[Croud CLI]: https://crate.io/docs/cloud/cli/
-[How-To Guides]: https://crate.io/docs/cloud/en/latest/howtos/
-[Reference]: https://crate.io/docs/cloud/en/latest/reference/
@@
-[Auditing]: https://cratedb.com/product/features/auditing
+[Support Plans]: https://cratedb.com/support/support-plans
-[AWS Marketplace]: https://aws.amazon.com/marketplace/pp/prodview-l7rqf2xpeaubk
-[Azure Marketplace]: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/crate.cratedbcloud?tab=overview
-[CCPA]: https://leginfo.legislature.ca.gov/faces/codes_displaySection.xhtml?lawCode=CIV&sectionNum=1798.140.
+[AWS Marketplace]: https://aws.amazon.com/marketplace/pp/prodview-l7rqf2xpeaubk
+[Azure Marketplace]: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/crate.cratedbcloud?tab=overview
+[GCP Marketplace]: https://console.cloud.google.com/marketplace/product/cratedb-public/cratedb-gcp
-[Database Features]: https://cratedb.com/docs/guide/feature/
-[Encryption]: https://cratedb.com/product/features/data-encryption
-[GCP Marketplace]: https://console.cloud.google.com/marketplace/product/cratedb-public/cratedb-gcp
-[GDPR]: https://gdpr-info.eu/
-[HIPAA]: https://www.cdc.gov/phlp/php/resources/health-insurance-portability-and-accountability-act-of-1996-hipaa.html?CDC_AAref_Val=https://www.cdc.gov/phlp/publications/topic/hipaa.html
-[ISO 27001]: https://cratedb.com/blog/cratedb-elevates-its-security-standards-and-achieves-iso-27001-certification
-[RBAC]: https://cratedb.com/product/features/authorization
-[secure, certified, and compliant]: https://cratedb.com/contact/security
-[SOC 2 Type 2]: https://cratedb.com/blog/soc-2-type-2-compliance
+[Database Features]: https://cratedb.com/docs/guide/feature/
+[secure, certified, and compliant]: https://cratedb.com/contact/security

Alternatively, add a short “See also” list to actually use them.

---

247-256: Scope CSS or upstream to theme (not a blocker).

Inline CSS is fine as a spike. Consider scoping the rule more narrowly (e.g., to this page’s containers) to avoid unintended side effects, or upstream this to the theme as noted.

-<style>
-.compact ul {
+<style>
+#cloud-docs-index .compact ul {
   margin-top: 0;
   margin-bottom: 0;
 }
 </style>

Note: The selector assumes id “cloud-docs-index”; if you prefer, wrap the page content in a dedicated class and scope to that instead.

📜 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 settings in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e3de153 and ee9ae7a.

📒 Files selected for processing (2)

• docs/cluster/console.md (1 hunks)
• docs/index.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/index.md

[grammar] ~51-~51: There might be a mistake here.
Context: ...rate options. :::: ::::: :::{toctree} :titlesonly: :hidden: Quick Start <tuto...

(QB_NEW_EN)

---

[grammar] ~52-~52: There might be a mistake here.
Context: ... :::: ::::: :::{toctree} :titlesonly: :hidden: Quick Start <tutorials/quick-s...

(QB_NEW_EN)

---

[grammar] ~55-~55: There might be a mistake here.
Context: ...en: Quick Start <tutorials/quick-start> Services <reference/services> Import <cl...

(QB_NEW_EN)

---

[grammar] ~56-~56: There might be a mistake here.
Context: ...ick-start> Services <reference/services> Import <cluster/import> Console <cluster...

(QB_NEW_EN)

---

[grammar] ~57-~57: There might be a mistake here.
Context: ...erence/services> Import <cluster/import> Console <cluster/console> Automation <cl...

(QB_NEW_EN)

---

[grammar] ~58-~58: There might be a mistake here.
Context: ...luster/import> Console <cluster/console> Automation <cluster/automation> Integrat...

(QB_NEW_EN)

---

[grammar] ~59-~59: There might be a mistake here.
Context: ...console> Automation <cluster/automation> Integrations <cluster/integrations/index...

(QB_NEW_EN)

---

[grammar] ~60-~60: There might be a mistake here.
Context: ...ntegrations <cluster/integrations/index> Export <cluster/export> Backups <cluster...

(QB_NEW_EN)

---

[grammar] ~61-~61: There might be a mistake here.
Context: ...egrations/index> Export <cluster/export> Backups <cluster/backups> Manage Cluster...

(QB_NEW_EN)

---

[grammar] ~62-~62: There might be a mistake here.
Context: ...luster/export> Backups <cluster/backups> Manage Cluster <cluster/manage> Billing ...

(QB_NEW_EN)

---

[grammar] ~63-~63: There might be a mistake here.
Context: ...backups> Manage Cluster <cluster/manage> Billing <organization/billing> Access Ma...

(QB_NEW_EN)

---

[grammar] ~64-~64: There might be a mistake here.
Context: ...r/manage> Billing <organization/billing> Access Management <organization/access-m...

(QB_NEW_EN)

---

[grammar] ~65-~65: There might be a mistake here.
Context: ...agement <organization/access-management> Networking & Connectivity <reference/net...

(QB_NEW_EN)

---

[grammar] ~66-~66: There might be a mistake here.
Context: ...ng & Connectivity <reference/networking> API <organization/api> How Tos <howtos/i...

(QB_NEW_EN)

---

[grammar] ~67-~67: There might be a mistake here.
Context: ...rence/networking> API <organization/api> How Tos <howtos/index> Croud CLI <tutori...

(QB_NEW_EN)

---

[grammar] ~68-~68: There might be a mistake here.
Context: ...organization/api> How Tos <howtos/index> Croud CLI <tutorials/deploy/croud> Refer...

(QB_NEW_EN)

---

[grammar] ~69-~69: There might be a mistake here.
Context: ...ndex> Croud CLI <tutorials/deploy/croud> Reference <reference/index> ::: (featu...

(QB_NEW_EN)

---

[grammar] ~70-~70: There might be a mistake here.
Context: ...eploy/croud> Reference <reference/index> ::: (feature)= (features)= (all-featur...

(QB_NEW_EN)

---

[grammar] ~74-~74: There might be a mistake here.
Context: ...rence <reference/index> ::: (feature)= (features)= (all-features)= :::{rubric} ...

(QB_NEW_EN)

---

[grammar] ~75-~75: There might be a mistake here.
Context: ...ence/index> ::: (feature)= (features)= (all-features)= :::{rubric} All Features...

(QB_NEW_EN)

---

[grammar] ~76-~76: There might be a mistake here.
Context: ... (feature)= (features)= (all-features)= :::{rubric} All Features ::: All featur...

(QB_NEW_EN)

---

[grammar] ~77-~77: There might be a mistake here.
Context: ...(all-features)= :::{rubric} All Features ::: All features of CrateDB Cloud at a ...

(QB_NEW_EN)

---

[grammar] ~82-~82: There might be a mistake here.
Context: ... Cloud at a glance. :::::{grid} 1 3 3 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 ...

(QB_NEW_EN)

---

[grammar] ~83-~83: There might be a mistake here.
Context: ...e. :::::{grid} 1 3 3 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :class-container:...

(QB_NEW_EN)

---

[grammar] ~84-~84: There might be a mistake here.
Context: ...id} 1 3 3 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :class-container: compact ::...

(QB_NEW_EN)

---

[grammar] ~85-~85: There might be a mistake here.
Context: ... :margin: 4 4 0 0 :padding: 0 :gutter: 2 :class-container: compact ::::{grid-ite...

(QB_NEW_EN)

---

[grammar] ~88-~88: There might be a mistake here.
Context: ...ined}power_settings_new;2em Functional :class-footer: text-smaller - [SQL Data...

(QB_NEW_EN)

---

[grammar] ~91-~91: There might be a mistake here.
Context: ...ss-footer: text-smaller - [SQL Database][Database Features] - {ref}SQL Console <cluster-console> - {...

(QB_NEW_EN)

---

[grammar] ~92-~92: There might be a mistake here.
Context: ...SQL Database][Database Features] - {ref}SQL Console <cluster-console> - {ref}cluster-automation - {ref}`cluste...

(QB_NEW_EN)

---

[grammar] ~93-~93: There might be a mistake here.
Context: ...}SQL Console <cluster-console> - {ref}cluster-automation - {ref}cluster-import - {ref}`cluster-ex...

(QB_NEW_EN)

---

[grammar] ~94-~94: There might be a mistake here.
Context: ...le> - {ref}cluster-automation - {ref}cluster-import - {ref}cluster-export - {ref}API <organ...

(QB_NEW_EN)

---

[grammar] ~95-~95: There might be a mistake here.
Context: ...omation - {ref}cluster-import - {ref}cluster-export - {ref}API - {ref}AP...

(QB_NEW_EN)

---

[grammar] ~96-~96: There might be a mistake here.
Context: ...-import - {ref}cluster-export - {ref}API - {ref}API CLI ...

(QB_NEW_EN)

---

[grammar] ~99-~99: There might be a mistake here.
Context: ...API CLI ` +++ CrateDB Cloud includes enhanced automati...

(QB_NEW_EN)

---

[grammar] ~101-~101: There might be a mistake here.
Context: ... of integrations with data ingestion and visualization tools. :::: ::::{grid-ite...

(QB_NEW_EN)

---

[grammar] ~102-~102: There might be a mistake here.
Context: ... data ingestion and visualization tools. :::: ::::{grid-item-card} {material-out...

(QB_NEW_EN)

---

[grammar] ~105-~105: There might be a mistake here.
Context: ...lined}assured_workload;2em Operational :class-footer: text-smaller - {ref}`Man...

(QB_NEW_EN)

---

[grammar] ~108-~108: There might be a mistake here.
Context: ...nal :class-footer: text-smaller - {ref}Management Console <cluster-manage> - {ref}`Automatic Backups <cluster-backups...

(QB_NEW_EN)

---

[grammar] ~111-~111: There might be a mistake here.
Context: ...Backups ` - Monitoring - [Support Plans] - Effortless Scaling - ...

(QB_NEW_EN)

---

[grammar] ~115-~115: There might be a mistake here.
Context: ...- [Support Plans] - Effortless Scaling - Zero Downtime Upgrades - Flexible Deploy...

(QB_NEW_EN)

---

[grammar] ~116-~116: There might be a mistake here.
Context: ...ortless Scaling - Zero Downtime Upgrades - Flexible Deployment: Full-managed vs. hy...

(QB_NEW_EN)

---

[grammar] ~119-~119: There might be a mistake here.
Context: ...aged vs. hybrid - Cost-effectiveness +++ CrateDB Cloud provides confident scaling...

(QB_NEW_EN)

---

[grammar] ~121-~121: There might be a mistake here.
Context: ... your preferred infrastructure provider. :::: ::::{grid-item-card} {material-out...

(QB_NEW_EN)

---

[grammar] ~124-~124: There might be a mistake here.
Context: ...erial-outlined}security;2em Confidence :class-footer: text-smaller - [Secure, ...

(QB_NEW_EN)

---

[grammar] ~127-~127: There might be a mistake here.
Context: ...ler - [Secure, certified, and compliant] - Marketplace Coverage: [AWS][AWS Marke...

(QB_NEW_EN)

---

[grammar] ~130-~130: There might be a mistake here.
Context: ...ure Marketplace], [GCP][GCP Marketplace] +++ CrateDB Cloud ensures secure data ma...

(QB_NEW_EN)

---

[grammar] ~131-~131: There might be a mistake here.
Context: ...Marketplace], [GCP][GCP Marketplace] +++ CrateDB Cloud ensures secure data manage...

(QB_NEW_EN)

---

[grammar] ~132-~132: There might be a mistake here.
Context: ... data management with its encryption and authentication mechanisms, and its opera...

(QB_NEW_EN)

---

[grammar] ~133-~133: There might be a mistake here.
Context: ...sms, and its operational certifications. :::: ::::: :::{rubric} Learn ::: If ...

(QB_NEW_EN)

---

[grammar] ~140-~140: There might be a mistake here.
Context: ...ations. :::: ::::: :::{rubric} Learn ::: If you want to start using CrateDB C...

(QB_NEW_EN)

---

[grammar] ~141-~141: There might be a mistake here.
Context: ...ns. :::: ::::: :::{rubric} Learn ::: If you want to start using CrateDB Cloud...

(QB_NEW_EN)

---

[grammar] ~142-~142: There might be a mistake here.
Context: ... CrateDB Cloud, or make the most of your existing subscription, we are maintainin...

(QB_NEW_EN)

---

[grammar] ~143-~143: There might be a mistake here.
Context: ... are maintaining resources and tutorials to support you correspondingly. ::::{g...

(QB_NEW_EN)

---

[grammar] ~147-~147: There might be a mistake here.
Context: ...ou correspondingly. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 ...

(QB_NEW_EN)

---

[grammar] ~148-~148: There might be a mistake here.
Context: ...y. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :::{grid-item-ca...

(QB_NEW_EN)

---

[grammar] ~149-~149: There might be a mistake here.
Context: ...id} 1 2 2 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :::{grid-item-card} {octicon...

(QB_NEW_EN)

---

[grammar] ~164-~164: There might be a mistake here.
Context: ...d-item-card} {octicon}terminal API CLI 🔗 cluster-deployment-croud :link-ty...

(QB_NEW_EN)

---

[grammar] ~165-~165: There might be a mistake here.
Context: ... API CLI 🔗 cluster-deployment-croud :link-type: ref Use services from the co...

(QB_NEW_EN)

---

[grammar] ~166-~166: There might be a mistake here.
Context: ...cluster-deployment-croud :link-type: ref Use services from the command-line. ::: ...

(QB_NEW_EN)

---

[grammar] ~167-~167: There might be a mistake here.
Context: ... ref Use services from the command-line. ::: :::{grid-item-card} {octicon}`table...

(QB_NEW_EN)

---

[grammar] ~193-~193: There might be a mistake here.
Context: ...ools and explore CrateDB's compatibility with analytics, ETL, BI, and monitoring ...

(QB_NEW_EN)

---

[grammar] ~197-~197: There might be a mistake here.
Context: ...nitoring solutions. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :gutter: 2 :::{grid-i...

(QB_NEW_EN)

---

[grammar] ~198-~198: There might be a mistake here.
Context: ...s. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :gutter: 2 :::{grid-item-card} {materi...

(QB_NEW_EN)

---

[grammar] ~202-~202: There might be a mistake here.
Context: ...-card} {material-outlined}link Connect 🔗 guide:connect :link-type: ref Ho...

(QB_NEW_EN)

---

[grammar] ~203-~203: There might be a mistake here.
Context: ...ined}link Connect 🔗 guide:connect :link-type: ref How to configure your f...

(QB_NEW_EN)

---

[grammar] ~209-~209: There might be a mistake here.
Context: ...rd} {material-outlined}download Ingest 🔗 guide:ingest :link-type: ref Lea...

(QB_NEW_EN)

---

[grammar] ~210-~210: There might be a mistake here.
Context: ...ed}download Ingest 🔗 guide:ingest :link-type: ref Learn how to get data i...

(QB_NEW_EN)

---

[grammar] ~216-~216: There might be a mistake here.
Context: ...ard} {material-outlined}sync Integrate 🔗 guide:integrate :link-type: ref ...

(QB_NEW_EN)

---

[grammar] ~217-~217: There might be a mistake here.
Context: ...}sync Integrate 🔗 guide:integrate :link-type: ref Learn about all compati...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.17.2)

docs/index.md

226-226: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb"

(MD053, link-image-reference-definitions)

---

227-227: Link and image reference definitions should be needed
Unused link or image reference definition: "croud cli"

(MD053, link-image-reference-definitions)

---

228-228: Link and image reference definitions should be needed
Unused link or image reference definition: "how-to guides"

(MD053, link-image-reference-definitions)

---

229-229: Link and image reference definitions should be needed
Unused link or image reference definition: "reference"

(MD053, link-image-reference-definitions)

---

231-231: Link and image reference definitions should be needed
Unused link or image reference definition: "auditing"

(MD053, link-image-reference-definitions)

---

234-234: Link and image reference definitions should be needed
Unused link or image reference definition: "ccpa"

(MD053, link-image-reference-definitions)

---

236-236: Link and image reference definitions should be needed
Unused link or image reference definition: "encryption"

(MD053, link-image-reference-definitions)

---

238-238: Link and image reference definitions should be needed
Unused link or image reference definition: "gdpr"

(MD053, link-image-reference-definitions)

---

239-239: Link and image reference definitions should be needed
Unused link or image reference definition: "hipaa"

(MD053, link-image-reference-definitions)

---

240-240: Link and image reference definitions should be needed
Unused link or image reference definition: "iso 27001"

(MD053, link-image-reference-definitions)

---

241-241: Link and image reference definitions should be needed
Unused link or image reference definition: "rbac"

(MD053, link-image-reference-definitions)

---

243-243: Link and image reference definitions should be needed
Unused link or image reference definition: "soc 2 type 2"

(MD053, link-image-reference-definitions)

🔇 Additional comments (2)

docs/index.md (2)

74-81: Nice “All Features” anchor set; good for deep-linking.

Providing multiple canonical anchors is pragmatic for future references.

---

197-224: Verify intersphinx targets for guide:connect/ingest/integrate.

These look like cross-project refs that depend on the “guide” intersphinx mapping.

See the earlier script in docs/cluster/console.md comment to ensure the “guide” mapping exists. After confirming, also check these refs resolve by searching for their targets in the repository (if mirrored) or verifying locally with a build.

[coderabbitai]

Actionable comments posted: 0

♻️ Duplicate comments (2)

docs/index.md (2)

55-69: Unify naming: “Console” → “SQL Console”; “API CLI” → “API CLI (croud)” for consistency

You already use “SQL Console” and “API CLI (croud)” in the Learn grid. Mirror that in the toctree for user consistency and findability. This was raised previously; echoing the suggestion here.

-Console <cluster/console>
+SQL Console <cluster/console>
@@
-API CLI <tutorials/deploy/croud>
+API CLI (croud) <tutorials/deploy/croud>

---

51-71: Toctree targets: acknowledging Sphinx resolution; no action needed

Re: earlier concern about missing toctree targets: based on your confirmation and our recorded learning for this repo, Sphinx resolves these correctly despite simple file searches. Not flagging this again.

🧹 Nitpick comments (5)

docs/index.md (5)

105-123: Fix phrasing: “Full-managed” → “Fully managed”

Minor grammar tweak in the Operational card.

-Flexible Deployment: Full-managed vs. hybrid
+Flexible deployment: Fully managed vs. hybrid

---

111-114: Consider linking or removing the bare “Monitoring” bullet

If there’s a monitoring page, link it; otherwise, consider removing to avoid dangling items in a curated list.

Would you like me to search the repo and propose the correct link target?

---

225-229: Remove unused link reference definitions

These references aren’t used on this page and trigger MD053. Remove to keep the file tidy.

-[CrateDB]: https://crate.io/product/
-[Croud CLI]: https://crate.io/docs/cloud/cli/
-[How-To Guides]: https://crate.io/docs/cloud/en/latest/howtos/
-[Reference]: https://crate.io/docs/cloud/en/latest/reference/

---

230-244: Prune additional unused link references; keep only those referenced

Leave “AWS/Azure/GCP Marketplace”, “Database Features”, “secure, certified, and compliant”, and “Support Plans”. The rest appear unused on this page and are flagged by MD053.

-[Auditing]: https://cratedb.com/product/features/auditing
 [AWS Marketplace]: https://aws.amazon.com/marketplace/pp/prodview-l7rqf2xpeaubk
 [Azure Marketplace]: https://azuremarketplace.microsoft.com/en-us/marketplace/apps/crate.cratedbcloud?tab=overview
-[CCPA]: https://leginfo.legislature.ca.gov/faces/codes_displaySection.xhtml?lawCode=CIV&sectionNum=1798.140.
 [Database Features]: https://cratedb.com/docs/guide/feature/
-[Encryption]: https://cratedb.com/product/features/data-encryption
 [GCP Marketplace]: https://console.cloud.google.com/marketplace/product/cratedb-public/cratedb-gcp
-[GDPR]: https://gdpr-info.eu/
-[HIPAA]: https://www.cdc.gov/phlp/php/resources/health-insurance-portability-and-accountability-act-of-1996-hipaa.html?CDC_AAref_Val=https://www.cdc.gov/phlp/publications/topic/hipaa.html
-[ISO 27001]: https://cratedb.com/blog/cratedb-elevates-its-security-standards-and-achieves-iso-27001-certification
-[RBAC]: https://cratedb.com/product/features/authorization
 [secure, certified, and compliant]: https://cratedb.com/contact/security
-[SOC 2 Type 2]: https://cratedb.com/blog/soc-2-type-2-compliance
 [Support Plans]: https://cratedb.com/support/support-plans

---

246-255: Inline CSS is fine for the spike; consider upstreaming to the theme

The compact list tweak matches the new grid usage. If you keep this pattern, upstreaming to crate-docs-theme will centralize styling.

I can draft a minimal PR to crate-docs-theme that adds .compact ul { margin: 0; } with a changelog entry. Want me to proceed?

📜 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 settings in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between ee9ae7a and f61dd32.

📒 Files selected for processing (1)

• docs/index.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-08-14T15:10:54.352Z

Learnt from: amotl
PR: crate/cloud-docs#88
File: docs/index.md:51-71
Timestamp: 2025-08-14T15:10:54.352Z
Learning: In the CrateDB Cloud documentation, toctree entries work correctly even when simple file searches don't find the referenced paths, indicating that Sphinx has specific path resolution rules or the files exist in locations not captured by basic fd searches.

Applied to files:

• docs/index.md

🪛 LanguageTool

docs/index.md

[grammar] ~51-~51: There might be a mistake here.
Context: ...rate options. :::: ::::: :::{toctree} :titlesonly: :hidden: Quick Start <tuto...

(QB_NEW_EN)

---

[grammar] ~52-~52: There might be a mistake here.
Context: ... :::: ::::: :::{toctree} :titlesonly: :hidden: Quick Start <tutorials/quick-s...

(QB_NEW_EN)

---

[grammar] ~55-~55: There might be a mistake here.
Context: ...en: Quick Start <tutorials/quick-start> Services <reference/services> Import <cl...

(QB_NEW_EN)

---

[grammar] ~56-~56: There might be a mistake here.
Context: ...ick-start> Services <reference/services> Import <cluster/import> Console <cluster...

(QB_NEW_EN)

---

[grammar] ~57-~57: There might be a mistake here.
Context: ...erence/services> Import <cluster/import> Console <cluster/console> Automation <cl...

(QB_NEW_EN)

---

[grammar] ~58-~58: There might be a mistake here.
Context: ...luster/import> Console <cluster/console> Automation <cluster/automation> Integrat...

(QB_NEW_EN)

---

[grammar] ~59-~59: There might be a mistake here.
Context: ...console> Automation <cluster/automation> Integrations <cluster/integrations/index...

(QB_NEW_EN)

---

[grammar] ~60-~60: There might be a mistake here.
Context: ...ntegrations <cluster/integrations/index> Export <cluster/export> Backups <cluster...

(QB_NEW_EN)

---

[grammar] ~61-~61: There might be a mistake here.
Context: ...egrations/index> Export <cluster/export> Backups <cluster/backups> Manage Cluster...

(QB_NEW_EN)

---

[grammar] ~62-~62: There might be a mistake here.
Context: ...luster/export> Backups <cluster/backups> Manage Cluster <cluster/manage> Billing ...

(QB_NEW_EN)

---

[grammar] ~63-~63: There might be a mistake here.
Context: ...backups> Manage Cluster <cluster/manage> Billing <organization/billing> Access Ma...

(QB_NEW_EN)

---

[grammar] ~64-~64: There might be a mistake here.
Context: ...r/manage> Billing <organization/billing> Access Management <organization/access-m...

(QB_NEW_EN)

---

[grammar] ~65-~65: There might be a mistake here.
Context: ...agement <organization/access-management> Networking & Connectivity <reference/net...

(QB_NEW_EN)

---

[grammar] ~66-~66: There might be a mistake here.
Context: ...ng & Connectivity <reference/networking> API <organization/api> API CLI <tutorial...

(QB_NEW_EN)

---

[grammar] ~67-~67: There might be a mistake here.
Context: ...rence/networking> API <organization/api> API CLI <tutorials/deploy/croud> How-tos...

(QB_NEW_EN)

---

[grammar] ~68-~68: There might be a mistake here.
Context: ...on/api> API CLI <tutorials/deploy/croud> How-tos <howtos/index> Reference <refere...

(QB_NEW_EN)

---

[grammar] ~69-~69: There might be a mistake here.
Context: ...als/deploy/croud> How-tos <howtos/index> Reference <reference/index> ::: (featu...

(QB_NEW_EN)

---

[grammar] ~70-~70: There might be a mistake here.
Context: ...owtos/index> Reference <reference/index> ::: (feature)= (features)= (all-featur...

(QB_NEW_EN)

---

[grammar] ~74-~74: There might be a mistake here.
Context: ...rence <reference/index> ::: (feature)= (features)= (all-features)= :::{rubric} ...

(QB_NEW_EN)

---

[grammar] ~75-~75: There might be a mistake here.
Context: ...ence/index> ::: (feature)= (features)= (all-features)= :::{rubric} All Features...

(QB_NEW_EN)

---

[grammar] ~76-~76: There might be a mistake here.
Context: ... (feature)= (features)= (all-features)= :::{rubric} All Features ::: All featur...

(QB_NEW_EN)

---

[grammar] ~77-~77: There might be a mistake here.
Context: ...(all-features)= :::{rubric} All Features ::: All features of CrateDB Cloud at a ...

(QB_NEW_EN)

---

[grammar] ~82-~82: There might be a mistake here.
Context: ... Cloud at a glance. :::::{grid} 1 3 3 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 ...

(QB_NEW_EN)

---

[grammar] ~83-~83: There might be a mistake here.
Context: ...e. :::::{grid} 1 3 3 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :class-container:...

(QB_NEW_EN)

---

[grammar] ~84-~84: There might be a mistake here.
Context: ...id} 1 3 3 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :class-container: compact ::...

(QB_NEW_EN)

---

[grammar] ~85-~85: There might be a mistake here.
Context: ... :margin: 4 4 0 0 :padding: 0 :gutter: 2 :class-container: compact ::::{grid-ite...

(QB_NEW_EN)

---

[grammar] ~88-~88: There might be a mistake here.
Context: ...ined}power_settings_new;2em Functional :class-footer: text-smaller - [SQL Data...

(QB_NEW_EN)

---

[grammar] ~91-~91: There might be a mistake here.
Context: ...ss-footer: text-smaller - [SQL Database][Database Features] - {ref}SQL Console <cluster-console> - {...

(QB_NEW_EN)

---

[grammar] ~92-~92: There might be a mistake here.
Context: ...SQL Database][Database Features] - {ref}SQL Console <cluster-console> - {ref}cluster-automation - {ref}`cluste...

(QB_NEW_EN)

---

[grammar] ~93-~93: There might be a mistake here.
Context: ...}SQL Console <cluster-console> - {ref}cluster-automation - {ref}cluster-import - {ref}`cluster-ex...

(QB_NEW_EN)

---

[grammar] ~94-~94: There might be a mistake here.
Context: ...le> - {ref}cluster-automation - {ref}cluster-import - {ref}cluster-export - {ref}API <organ...

(QB_NEW_EN)

---

[grammar] ~95-~95: There might be a mistake here.
Context: ...omation - {ref}cluster-import - {ref}cluster-export - {ref}API - {ref}AP...

(QB_NEW_EN)

---

[grammar] ~96-~96: There might be a mistake here.
Context: ...-import - {ref}cluster-export - {ref}API - {ref}API CLI ...

(QB_NEW_EN)

---

[grammar] ~99-~99: There might be a mistake here.
Context: ...API CLI ` +++ CrateDB Cloud includes enhanced automati...

(QB_NEW_EN)

---

[grammar] ~101-~101: There might be a mistake here.
Context: ... of integrations with data ingestion and visualization tools. :::: ::::{grid-ite...

(QB_NEW_EN)

---

[grammar] ~102-~102: There might be a mistake here.
Context: ... data ingestion and visualization tools. :::: ::::{grid-item-card} {material-out...

(QB_NEW_EN)

---

[grammar] ~105-~105: There might be a mistake here.
Context: ...lined}assured_workload;2em Operational :class-footer: text-smaller - {ref}`Man...

(QB_NEW_EN)

---

[grammar] ~108-~108: There might be a mistake here.
Context: ...nal :class-footer: text-smaller - {ref}Management Console <cluster-manage> - {ref}`Automatic Backups <cluster-backups...

(QB_NEW_EN)

---

[grammar] ~111-~111: There might be a mistake here.
Context: ...Backups ` - Monitoring - [Support Plans] - Effortless Scaling - ...

(QB_NEW_EN)

---

[grammar] ~115-~115: There might be a mistake here.
Context: ...- [Support Plans] - Effortless Scaling - Zero Downtime Upgrades - Flexible Deploy...

(QB_NEW_EN)

---

[grammar] ~116-~116: There might be a mistake here.
Context: ...ortless Scaling - Zero Downtime Upgrades - Flexible Deployment: Full-managed vs. hy...

(QB_NEW_EN)

---

[grammar] ~119-~119: There might be a mistake here.
Context: ...aged vs. hybrid - Cost-effectiveness +++ CrateDB Cloud provides reliable scaling ...

(QB_NEW_EN)

---

[grammar] ~120-~120: There might be a mistake here.
Context: ...vides reliable scaling of your workloads and deployments on your preferred infras...

(QB_NEW_EN)

---

[grammar] ~121-~121: There might be a mistake here.
Context: ... your preferred infrastructure provider. :::: ::::{grid-item-card} {material-out...

(QB_NEW_EN)

---

[grammar] ~124-~124: There might be a mistake here.
Context: ...ned}security;2em Security & Compliance :class-footer: text-smaller - [Secure, ...

(QB_NEW_EN)

---

[grammar] ~127-~127: There might be a mistake here.
Context: ...ler - [Secure, certified, and compliant] - Marketplace Coverage: [AWS][AWS Marke...

(QB_NEW_EN)

---

[grammar] ~130-~130: There might be a mistake here.
Context: ...ure Marketplace], [GCP][GCP Marketplace] +++ CrateDB Cloud ensures secure data ma...

(QB_NEW_EN)

---

[grammar] ~131-~131: There might be a mistake here.
Context: ...Marketplace], [GCP][GCP Marketplace] +++ CrateDB Cloud ensures secure data manage...

(QB_NEW_EN)

---

[grammar] ~132-~132: There might be a mistake here.
Context: ... data management with its encryption and authentication mechanisms, and its opera...

(QB_NEW_EN)

---

[grammar] ~133-~133: There might be a mistake here.
Context: ...sms, and its operational certifications. :::: ::::: :::{rubric} Learn ::: If ...

(QB_NEW_EN)

---

[grammar] ~140-~140: There might be a mistake here.
Context: ...ations. :::: ::::: :::{rubric} Learn ::: If you are getting started with Crat...

(QB_NEW_EN)

---

[grammar] ~141-~141: There might be a mistake here.
Context: ...ns. :::: ::::: :::{rubric} Learn ::: If you are getting started with CrateDB ...

(QB_NEW_EN)

---

[grammar] ~142-~142: There might be a mistake here.
Context: ...teDB Cloud—or want to get more from your subscription—we provide resources and tu...

(QB_NEW_EN)

---

[grammar] ~146-~146: There might be a mistake here.
Context: ... tutorials to help. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 ...

(QB_NEW_EN)

---

[grammar] ~147-~147: There might be a mistake here.
Context: ...p. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :::{grid-item-ca...

(QB_NEW_EN)

---

[grammar] ~148-~148: There might be a mistake here.
Context: ...id} 1 2 2 3 :margin: 4 4 0 0 :padding: 0 :gutter: 2 :::{grid-item-card} {octicon...

(QB_NEW_EN)

---

[grammar] ~163-~163: There might be a mistake here.
Context: ...ard} {octicon}terminal API CLI (croud) 🔗 cluster-deployment-croud :link-ty...

(QB_NEW_EN)

---

[grammar] ~164-~164: There might be a mistake here.
Context: ... (croud) 🔗 cluster-deployment-croud :link-type: ref Use services from the co...

(QB_NEW_EN)

---

[grammar] ~165-~165: There might be a mistake here.
Context: ...cluster-deployment-croud :link-type: ref Use services from the command-line. ::: ...

(QB_NEW_EN)

---

[grammar] ~166-~166: There might be a mistake here.
Context: ... ref Use services from the command-line. ::: :::{grid-item-card} {octicon}`table...

(QB_NEW_EN)

---

[grammar] ~192-~192: There might be a mistake here.
Context: ...ools and explore CrateDB's compatibility with analytics, ETL, BI, and monitoring ...

(QB_NEW_EN)

---

[grammar] ~196-~196: There might be a mistake here.
Context: ...nitoring solutions. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :gutter: 2 :::{grid-i...

(QB_NEW_EN)

---

[grammar] ~197-~197: There might be a mistake here.
Context: ...s. ::::{grid} 1 2 2 3 :margin: 4 4 0 0 :gutter: 2 :::{grid-item-card} {materi...

(QB_NEW_EN)

---

[grammar] ~201-~201: There might be a mistake here.
Context: ...-card} {material-outlined}link Connect 🔗 guide:connect :link-type: ref Ho...

(QB_NEW_EN)

---

[grammar] ~202-~202: There might be a mistake here.
Context: ...ined}link Connect 🔗 guide:connect :link-type: ref How to configure your f...

(QB_NEW_EN)

---

[grammar] ~208-~208: There might be a mistake here.
Context: ...rd} {material-outlined}download Ingest 🔗 guide:ingest :link-type: ref Lea...

(QB_NEW_EN)

---

[grammar] ~209-~209: There might be a mistake here.
Context: ...ed}download Ingest 🔗 guide:ingest :link-type: ref Learn how to get data i...

(QB_NEW_EN)

---

[grammar] ~215-~215: There might be a mistake here.
Context: ...ard} {material-outlined}sync Integrate 🔗 guide:integrate :link-type: ref ...

(QB_NEW_EN)

---

[grammar] ~216-~216: There might be a mistake here.
Context: ...}sync Integrate 🔗 guide:integrate :link-type: ref Learn about all compati...

(QB_NEW_EN)

🪛 markdownlint-cli2 (0.17.2)

docs/index.md

225-225: Link and image reference definitions should be needed
Unused link or image reference definition: "cratedb"

(MD053, link-image-reference-definitions)

---

226-226: Link and image reference definitions should be needed
Unused link or image reference definition: "croud cli"

(MD053, link-image-reference-definitions)

---

227-227: Link and image reference definitions should be needed
Unused link or image reference definition: "how-to guides"

(MD053, link-image-reference-definitions)

---

228-228: Link and image reference definitions should be needed
Unused link or image reference definition: "reference"

(MD053, link-image-reference-definitions)

---

230-230: Link and image reference definitions should be needed
Unused link or image reference definition: "auditing"

(MD053, link-image-reference-definitions)

---

233-233: Link and image reference definitions should be needed
Unused link or image reference definition: "ccpa"

(MD053, link-image-reference-definitions)

---

235-235: Link and image reference definitions should be needed
Unused link or image reference definition: "encryption"

(MD053, link-image-reference-definitions)

---

237-237: Link and image reference definitions should be needed
Unused link or image reference definition: "gdpr"

(MD053, link-image-reference-definitions)

---

238-238: Link and image reference definitions should be needed
Unused link or image reference definition: "hipaa"

(MD053, link-image-reference-definitions)

---

239-239: Link and image reference definitions should be needed
Unused link or image reference definition: "iso 27001"

(MD053, link-image-reference-definitions)

---

240-240: Link and image reference definitions should be needed
Unused link or image reference definition: "rbac"

(MD053, link-image-reference-definitions)

---

242-242: Link and image reference definitions should be needed
Unused link or image reference definition: "soc 2 type 2"

(MD053, link-image-reference-definitions)

🔇 Additional comments (2)

docs/index.md (2)

74-87: Good “All Features” section scaffold

Solid landing/index structure with clear category anchors and alias labels (feature/features/all-features). This should help both users and search/navigation.

---

201-222: Verify guide: cross‑refs resolve via intersphinx or project labels

I couldn't find local label anchors for connect/ingest/integrate and docs/conf.py does not define an intersphinx_mapping locally — docs/conf.py imports crate.theme.rtd.conf.cloud, which may supply the mapping but its source isn't in this repo. Please confirm the imported conf or the target project provides a "guide" intersphinx prefix or that the target pages define labels.

Files to check:

• docs/index.md (≈ lines 201–216): ::link: guide:connect / ::link: guide:ingest / ::link: guide:integrate
• docs/tutorials/quick-start.md (≈ lines 146, 155, 170, 187, 199): multiple guide: refs (features, objects-basics, timeseries-objects, search-basics, timeseries-analysis-weather)
• docs/conf.py: imports crate.theme.rtd.conf.cloud — inspect that module for intersphinx_mapping or equivalent

Actionable options:

• If crate.theme.rtd.conf.cloud provides the mapping, no change needed.
• Otherwise add an intersphinx_mapping entry for the "guide" inventory in docs/conf.py or add explicit labels/anchors in the target guide files (e.g., (connect)= or {#connect}) so ref targets resolve.

[amotl]

Thanks for your feedback. We think all admonitions have been addressed now. Please have a look with a fresh eye.

-- https://crate-cloud--88.org.readthedocs.build/en/88/