Datashader: Index page with reference to notebook

[amotl]

About

Continue adding integration guides from the community forum.

Preview

• https://cratedb-guide--286.org.readthedocs.build/integrate/datashader/

References

• Consolidate Integration Guides I vs. II #102

[coderabbitai]

Walkthrough

Adds a HoloViz link include; updates Dask docs to reframe “tutorial” as “usage”; introduces a new Datashader integration landing page; and rewrites the PyViz integration page to focus on hvPlot with adjusted links and layout.

Changes

Cohort / File(s)	Change summary
Shared links include docs/_include/links.md	Adds a public link declaration for HoloViz.
Dask integration docs docs/integrate/dask/index.md, docs/integrate/dask/usage.md	Renames references from “tutorial” to “usage,” updates titles, toctree entry, and wording to match “usage guide.”
Datashader integration page docs/integrate/datashader/index.md	Adds a new Datashader landing page with logo, grid layout, example links, and a Learn section include.
PyViz integration page refocus docs/integrate/pyviz/index.md	Replaces header logo, removes explicit Datashader section, shifts narrative to hvPlot-centric description, updates grid and references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Dask: Index page and starter tutorial #287 — Also edits Dask integration docs around tutorial/usage content.
• ETL/CDC: Guidance, Layout / Dissolve walls of links #239 — Modifies docs/_include/links.md by adding link entries and lint directives.
• Machine learning: Rework and relocate section #314 — Touches docs/_include/links.md and Datashader-related documentation.

Suggested labels

cross linking

Suggested reviewers

• surister
• kneth
• bmunkholm

Poem

A whisk of links, a hop through docs—
I nudge the trail from tutorial to talks.
New Datashader burrows glow and bright,
PyViz hums with hvPlot’s light.
With ears up high and markdown neat,
I thump “merge” with happy feet. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title only references adding a Datashader index page, but the pull request also updates the Dask and PyViz integration guides and adds a new HoloViz link, so it does not accurately summarize the main changes across the entire changeset.	Please update the title to concisely reflect the full scope of changes, such as “docs: add integration guides for Dask, Datashader, PyViz and update HoloViz links.”

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	The description clearly states that the PR continues adding integration guides from the community forum and provides a preview link and reference, which is directly related to the changes being introduced.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch datashader

---

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

🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

• Public repositories are always opted into early access features.
• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/integrate/pyviz/index.md (1)

39-54: Consider reducing content duplication between PyViz and Datashader pages.

Both docs/integrate/pyviz/index.md and docs/integrate/datashader/index.md include:

• The same Datashader example images (lines 39-44, ds1 and ds2)
• The same Learn section with timeseries-datashader.md card include (lines 51-54)

Since Datashader now has a dedicated page that's cross-referenced from this hvPlot section (Line 31), consider:

1. Removing the duplicate images and Learn section from the PyViz page, or
2. Having the PyViz page showcase hvPlot-specific examples instead

This would reduce maintenance overhead and provide clearer separation of concerns.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8f3d2eb and 2512ef3.

📒 Files selected for processing (5)

• docs/_include/links.md (1 hunks)
• docs/integrate/dask/index.md (2 hunks)
• docs/integrate/dask/usage.md (3 hunks)
• docs/integrate/datashader/index.md (1 hunks)
• docs/integrate/pyviz/index.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Build docs

🔇 Additional comments (13)

docs/_include/links.md (1)

38-38: LGTM! HoloViz link addition is correctly formatted.

The new link declaration follows the existing pattern and is alphabetically ordered between HoloViews and Indexing entries.

docs/integrate/datashader/index.md (3)

1-11: LGTM! Header and logo placement are well-structured.

The page header follows standard documentation conventions with proper label definition, includes, and floating logo layout.

---

43-46: Learn section include verified: docs/_include/card/timeseries-datashader.md exists and renders correctly.

---

31-36: Please run the following script to follow redirects and confirm the GitHub asset URLs resolve with HTTP 200:

#!/bin/bash
echo "Checking ds1 final status..."
curl -I -L -s -o /dev/null -w "%{http_code}" "https://github.com/crate/crate-clients-tools/assets/453543/7f38dff6-04bc-429e-9d31-6beeb9289c4b"

echo ""
echo "Checking ds2 final status..."
curl -I -L -s -o /dev/null -w "%{http_code}" "https://github.com/crate/crate-clients-tools/assets/453543/23561a87-fb4f-4154-9891-1b3068e40579"

docs/integrate/pyviz/index.md (3)

8-8: LGTM! Logo sizing is appropriate.

The PyViz logo height has been adjusted to 100px, providing better visual prominence on the page.

---

16-17: LGTM! Section rename aligns with documentation restructuring.

Renaming from "hvPlot and Datashader" to just "hvPlot" makes sense given that Datashader now has its own dedicated page.

---

25-33: LGTM! Content refactoring improves documentation structure.

The narrative now positions hvPlot as the primary focus while appropriately cross-referencing the dedicated Datashader page. The use of {ref}datashader ensures proper linking.

docs/integrate/dask/index.md (2)

29-29: LGTM! Cross-reference updated to match refactored label.

The reference correctly points to the renamed dask-usage label, maintaining consistency with the refactored documentation.

---

38-38: LGTM! Navigation label updated for clarity.

Changing the toctree entry from "Tutorial" to "Usage" aligns with the refactored content terminology and provides clearer navigation.

docs/integrate/dask/usage.md (4)

1-1: LGTM! Label refactored for consistency.

The label has been updated from dask-tutorial to dask-usage, aligning with the terminology changes throughout the documentation.

---

5-6: LGTM! Introduction reframed as a usage guide.

The wording has been updated from "tutorial" to "usage guide," which better describes the nature of the documentation content.

---

24-24: LGTM! Terminology consistency maintained.

The reference to "tutorial" has been appropriately changed to "usage guide" in the Inserting data section.

---

194-194: LGTM! Conclusion updated with consistent terminology.

The final reference to "tutorial" has been changed to "usage guide," completing the terminology refactoring throughout the document.