Fix broken links after reorg in cratedb-examples
#220
Conversation
WalkthroughThis update revises documentation links across several markdown files. It modifies URL paths for LangChain, PyCaret, and MLflow example resources, reflecting changes in directory structure or file names within the referenced repositories. No content, logic, or public entity declarations were altered—only the target URLs of various documentation references. Changes
Sequence Diagram(s)No sequence diagram is generated, as all changes are limited to documentation link updates. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ 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 comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/_include/links.md(1 hunks)docs/domain/ml/index.md(2 hunks)docs/domain/timeseries/advanced.md(1 hunks)docs/integrate/langchain/index.md(1 hunks)docs/integrate/llamaindex/index.md(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
📚 Learning: in the cratedb guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) ...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:8-20
Timestamp: 2025-05-18T12:50:38.681Z
Learning: In the CrateDB guide repository, references with the `ctk:` prefix (like `ctk:query/mcp/landscape`) are intersphinx references that link to resources in the cratedb-toolkit repository (https://github.com/crate/cratedb-toolkit/tree/main/doc), which are rendered at https://cratedb-toolkit.readthedocs.io/. These are valid cross-references between separate Sphinx documentation sets, not local file references.
Applied to files:
docs/integrate/llamaindex/index.mddocs/_include/links.mddocs/integrate/langchain/index.mddocs/domain/timeseries/advanced.mddocs/domain/ml/index.md
📚 Learning: in the cratedb guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/serve...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:22-33
Timestamp: 2025-05-18T12:50:36.393Z
Learning: In the CrateDB Guide repository, the prefix `ctk:` in documentation links (like `ctk:query/mcp/server`) is an intersphinx reference that points to external content in the CrateDB Toolkit documentation at https://cratedb-toolkit.readthedocs.io/. These references are intentionally not pointing to local files within the repository.
Applied to files:
docs/_include/links.mddocs/domain/timeseries/advanced.md
📚 Learning: in the cratedb guide documentation, particularly for mcp-related pages, the author prefers a 1-colum...
Learnt from: amotl
PR: crate/cratedb-guide#204
File: docs/integrate/mcp/community.md:6-8
Timestamp: 2025-05-18T13:25:11.786Z
Learning: In the CrateDB Guide documentation, particularly for MCP-related pages, the author prefers a 1-column grid layout for multiple cards to stack them vertically rather than side by side, as this is an intentional design choice.
Applied to files:
docs/_include/links.md
🪛 markdownlint-cli2 (0.17.2)
docs/_include/links.md
32-32: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain and cratedb: code examples"
(MD053, link-image-reference-definitions)
33-33: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-similarity-binder"
(MD053, link-image-reference-definitions)
34-34: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-similarity-colab"
(MD053, link-image-reference-definitions)
35-35: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-similarity-github"
(MD053, link-image-reference-definitions)
36-36: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-rag-sql-binder"
(MD053, link-image-reference-definitions)
37-37: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-rag-sql-colab"
(MD053, link-image-reference-definitions)
38-38: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-rag-sql-github"
(MD053, link-image-reference-definitions)
⏰ 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 (4)
docs/integrate/llamaindex/index.md (1)
111-111: demo_nlsql.py Link Confirmed
The file attopic/machine-learning/llama-index/demo_nlsql.pyreturns HTTP 200 on themainbranch, so the link indocs/integrate/llamaindex/index.mdis valid. No changes required.docs/integrate/langchain/index.md (1)
219-225: LGTM – links updated to newlangchain/folderThe GitHub, Colab and Binder URLs reflect the repo re-org and look syntactically correct (URL-encoded path for Binder included).
No further action needed, just merge once CI passes.docs/domain/timeseries/advanced.md (1)
271-277: Notebook links verified – paths are validBoth Merlion and PyCaret notebooks return HTTP 200 at their new locations, so the links will resolve correctly. No further changes are needed.
docs/domain/ml/index.md (1)
293-294: Good catch – MLflow notebook links updatedLinks point to the new
mlflow/folder and look correct.
No issues spotted.
| [LangChain and CrateDB: Code Examples]: https://github.com/crate/cratedb-examples/tree/main/topic/machine-learning/langchain | ||
| [langchain-similarity-binder]: https://mybinder.org/v2/gh/crate/cratedb-examples/main?labpath=topic%2Fmachine-learning%2Flangchain%2Fvector_search.ipynb | ||
| [langchain-similarity-colab]: https://colab.research.google.com/github/crate/cratedb-examples/blob/main/topic/machine-learning/langchain/vector_search.ipynb | ||
| [langchain-similarity-github]: https://github.com/crate/cratedb-examples/blob/main/topic/machine-learning/langchain/vector_search.ipynb | ||
| [langchain-rag-sql-binder]: https://mybinder.org/v2/gh/crate/cratedb-examples/main?labpath=topic%2Fmachine-learning%2Flangchain%2Fcratedb-vectorstore-rag-openai-sql.ipynb | ||
| [langchain-rag-sql-colab]: https://colab.research.google.com/github/crate/cratedb-examples/blob/main/topic/machine-learning/langchain/cratedb-vectorstore-rag-openai-sql.ipynb | ||
| [langchain-rag-sql-github]: https://github.com/crate/cratedb-examples/blob/main/topic/machine-learning/langchain/cratedb-vectorstore-rag-openai-sql.ipynb |
There was a problem hiding this comment.
New LangChain link definitions are currently unused – will break markdownlint
markdownlint (MD053) flags all seven newly-added definitions as “unused”.
Unless they are referenced in another file that is included after linting runs, either:
- Remove the definitions, or
- Add at least one reference to each, so the linter sees them as used.
Failing to do so will keep CI red.
- [LangChain and CrateDB: Code Examples]: https://github.com/crate/cratedb-examples/tree/main/topic/machine-learning/langchain
- … (delete the other six unused definitions) …Or create references in the affected pages.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
32-32: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain and cratedb: code examples"
(MD053, link-image-reference-definitions)
33-33: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-similarity-binder"
(MD053, link-image-reference-definitions)
34-34: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-similarity-colab"
(MD053, link-image-reference-definitions)
35-35: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-similarity-github"
(MD053, link-image-reference-definitions)
36-36: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-rag-sql-binder"
(MD053, link-image-reference-definitions)
37-37: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-rag-sql-colab"
(MD053, link-image-reference-definitions)
38-38: Link and image reference definitions should be needed
Unused link or image reference definition: "langchain-rag-sql-github"
(MD053, link-image-reference-definitions)
🤖 Prompt for AI Agents
In docs/_include/links.md around lines 32 to 38, the newly added LangChain link
definitions are flagged as unused by markdownlint (MD053), causing CI failures.
To fix this, either remove these unused link definitions or add references to
each link in the markdown content so the linter recognizes them as used.
Alternatively, ensure these links are referenced in other files included before
linting runs.
| [automl-classify-github]: https://github.com/crate/cratedb-examples/blob/main/topic/machine-learning/pycaret/automl_classification_with_pycaret.py | ||
| [automl-classify-colab]: https://colab.research.google.com/github/crate/cratedb-examples/blob/main/topic/machine-learning/pycaret/automl_classification_with_pycaret.ipynb | ||
| [automl-forecasting-github]: https://github.com/crate/cratedb-examples/blob/main/topic/machine-learning/pycaret/automl_timeseries_forecasting_with_pycaret.ipynb |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Mismatch between .py and .ipynb formats for the classification tutorial
GitHub link now targets automl_classification_with_pycaret.py, while the Colab link still uses the notebook version.
If the notebook has been converted to a script, provide a script-friendly Colab link or keep both files aligned to avoid confusing readers.
🤖 Prompt for AI Agents
In docs/domain/ml/index.md around lines 274 to 276, the GitHub link points to a
Python script (.py) for the classification tutorial, but the Colab link still
points to the notebook (.ipynb) version, causing inconsistency. To fix this,
either update the Colab link to a script-friendly version if available or ensure
both links consistently point to the same format (both .py or both .ipynb) to
avoid confusing readers.
What the title says. NB: Without a link checker, it wouldn't be possible to reorganize any content. Without a corresponding job on CI, nobody would notice.