Prompt: Educate about standalone use with llm program

[amotl]

About

Resources in this repository can be used to interact with LLMs in a standalone way. This patch adds relevant documentation, and applies a few "naming things" details along the way.

Synopsis

Hold an ongoing chat with a model using the versatile llm application.

uvx llm chat --model gpt-4.1 --option temperature 0.5 \
  --fragment https://cdn.crate.io/about/v1/llms-full.txt \
  --system-fragment https://cdn.crate.io/about/v1/instructions-general.md

Details

• Prompt: Add instructions-general.md file when generating bundle

The file is now being produced to this location using a Jenkins job.

• https://cdn.crate.io/about/v1/instructions-general.md

References

• Query: Use llm program instead of cratedb-about ask #45

[coderabbitai]

"""

Walkthrough

References to the CrateDB instructions file were renamed and relocated throughout the documentation and codebase. The CLI now generates an instructions-general.md file using the updated prompt resource. Associated documentation and test imports were updated to match the new file name and location.

Changes

File(s)	Change Summary
CHANGES.md	Added changelog entry for inclusion of instructions-general.md in the bundle.
README.md, src/cratedb_about/bundle/readme.md	Updated references and documentation for the instructions file to the new name and location.
src/cratedb_about/cli.py	Enhanced bundle command to write instructions-general.md using the new prompt resource.
src/cratedb_about/prompt/init.py	Changed GeneralInstructions to load from prompt/instructions.md instead of the old path.
tests/test_prompt.py	Updated import to reflect new module location for GeneralInstructions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI (bundle)
    participant CrateDbLllmsTxtBuilder
    participant GeneralInstructions

    User->>CLI (bundle): Run bundle command
    CLI (bundle)->>CrateDbLllmsTxtBuilder: Build llms.txt bundle
    CrateDbLllmsTxtBuilder-->>CLI (bundle): Return llms.txt files
    CLI (bundle)->>GeneralInstructions: Render instructions
    GeneralInstructions-->>CLI (bundle): Return instructions text
    CLI (bundle)->>CLI (bundle): Write instructions-general.md to output

Loading

Estimated code review effort

2 (~15 minutes)

Possibly related PRs

• Prompt: Add instructions about working with CrateDB #52: Adds the original instructions file and the GeneralInstructions class, which are directly modified and referenced in this PR.

Suggested reviewers

• surister
• WalBeh
• kneth

Poem

A rabbit hopped through code so neat,
Renamed some files, made docs complete.
Bundled instructions, clear and grand,
Now prompts and tests all understand.
With every hop, the code aligns—
🐇✨ In tidy files, the logic shines!
"""

---

📜 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 c1119a5 and 4174ee7.

📒 Files selected for processing (2)

• CHANGES.md (1 hunks)
• README.md (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

• CHANGES.md
• README.md

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch evolve-instructions

---

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. Examples:
  • @coderabbitai explain this code block.
  • @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 explain its main purpose.
  • @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 generate unit tests to generate unit tests for 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.