Skip to content

cratedb-about ask: Use location /about#10

Merged
amotl merged 3 commits intomainfrom
use-webserver
May 9, 2025
Merged

cratedb-about ask: Use location /about#10
amotl merged 3 commits intomainfrom
use-webserver

Conversation

@amotl
Copy link
Member

@amotl amotl commented May 8, 2025

About

After publishing the generated resources to https://cdn.crate.io/about/v1/, we can use/pull the llms-full.txt file from there.

References

@amotl amotl requested review from WalBeh, kneth and surister May 8, 2025 18:14
@coderabbitai
Copy link

coderabbitai bot commented May 8, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The changes update documentation and configuration to reflect a new CDN-hosted location for generated context files, replacing references to local or GitHub-based paths. The .gitignore file is updated to ignore new patterns, and a context file is deleted from the repository. The environment variable default for context file URLs is also updated.

Changes

File(s) Change Summary
.gitignore Reordered bdist.* pattern and added build/llm/*.txt to ignore .txt files in that folder.
CHANGES.md Added documentation entry about advertising the new CDN resource location URL.
README.md Updated context file location from [build/llm] to [about/v1], changed links to CDN URLs, and documented the CRATEDB_CONTEXT_URL environment variable.
build/llm/llms.txt Deleted the comprehensive CrateDB resource guide/context file.
src/cratedb_about/model.py Changed the default value for CRATEDB_CONTEXT_URL from a GitHub URL to a CDN URL.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant CDN

    User->>App: Starts application
    App->>App: Read CRATEDB_CONTEXT_URL (env or default)
    App->>CDN: Fetch context file from https://cdn.crate.io/about/v1/llms-full.txt
    CDN-->>App: Return context file
    App-->>User: Application runs using fetched context
Loading

Possibly related PRs

Suggested reviewers

  • bmunkholm

Poem

In burrows deep, a change took flight,
Old paths replaced by links of light.
The context now from CDN flows,
While .txt files rest where no one goes.
With docs refreshed and settings new,
This rabbit hops to pastures true! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17938be and 8dc4930.

📒 Files selected for processing (5)
  • .gitignore (1 hunks)
  • CHANGES.md (1 hunks)
  • README.md (2 hunks)
  • build/llm/llms.txt (0 hunks)
  • src/cratedb_about/model.py (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • 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 src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

Documentation and Community

  • 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.

@amotl amotl marked this pull request as ready for review May 8, 2025 18:16
Copy link

@coderabbitai coderabbitai bot left a 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)
CHANGES.md (1)

5-6: Wrap bare URL to satisfy markdownlint
The URL https://cdn.crate.io/about/ is flagged as a bare URL (MD034). To comply with markdownlint rules, wrap it in angle brackets or convert it to a markdown link.

- - Documentation: Started advertising to use the designated location
-   https://cdn.crate.io/about/ for consuming the generated resources
+ - Documentation: Started advertising to use the designated location <https://cdn.crate.io/about/> for consuming the generated resources
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

6-6: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75f7a35 and 2af8e34.

📒 Files selected for processing (5)
  • .gitignore (1 hunks)
  • CHANGES.md (1 hunks)
  • README.md (2 hunks)
  • build/llm/llms.txt (0 hunks)
  • src/cratedb_about/model.py (1 hunks)
💤 Files with no reviewable changes (1)
  • build/llm/llms.txt
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGES.md

6-6: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Python 3.13
🔇 Additional comments (6)
.gitignore (2)

6-6: Skip reordering of bdist. pattern*
The relocation of bdist.* below __pycache__ is purely cosmetic and does not impact functionality.


7-7: Ignore local build context files
Adding build/llm/*.txt to .gitignore correctly prevents version control of obsolete context files after migrating them to the CDN.

src/cratedb_about/model.py (1)

44-47:

Details

✅ Verification successful

Update default context URL to CDN
The default CRATEDB_CONTEXT_URL is updated to the new CDN path, matching documentation. Please verify the new endpoint is reachable and returns valid content.


🏁 Script executed:

#!/usr/bin/env bash
# Verify CDN URL for context file
curl -s -o /dev/null -w "%{http_code}" https://cdn.crate.io/about/v1/llms-ctx-full.txt

Length of output: 92


CDN URL Verified – Approving Default Context URL Update
The new CRATEDB_CONTEXT_URL endpoint (https://cdn.crate.io/about/v1/llms-ctx-full.txt) returns HTTP 200 and serves valid content, matching the documentation.

• File: src/cratedb_about/model.py Lines 44–47 — default URL updated to CDN and verified reachable.

README.md (3)

16-18: Update documentation to reference CDN folder
This change correctly points users to the new [about/v1] CDN location for generated LLMS context files, aligning with the other updates.


38-39: Add instructions for custom context URL
Providing guidance on using the CRATEDB_CONTEXT_URL environment variable enhances flexibility.


42-42: Define CDN link reference
The link definition for [about/v1] is updated to the CDN URL, ensuring the markdown link resolves correctly.

@amotl amotl changed the title Web server: Use location /about cratedb-about ask: Use location /about May 8, 2025
@amotl amotl force-pushed the use-webserver branch from 2af8e34 to 17938be Compare May 8, 2025 19:27
@amotl amotl requested a review from bmunkholm May 9, 2025 10:59
@amotl amotl force-pushed the use-webserver branch from 17938be to 8dc4930 Compare May 9, 2025 13:26
@amotl amotl merged commit 8696c92 into main May 9, 2025
2 of 3 checks passed
@amotl amotl deleted the use-webserver branch May 9, 2025 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant