Skip to content

Naming things: Adhere to the naming convention of https://llmtxt.dev/hub#11

Merged
amotl merged 1 commit intomainfrom
naming-things
May 9, 2025
Merged

Naming things: Adhere to the naming convention of https://llmtxt.dev/hub#11
amotl merged 1 commit intomainfrom
naming-things

Conversation

@amotl
Copy link
Member

@amotl amotl commented May 8, 2025

https://llmtxt.dev/hub uses llms.txt and llms-full.txt. Let's use the same convention.

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

coderabbitai bot commented May 8, 2025

Warning

Rate limit exceeded

@amotl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 24 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 c46f95a and f9fc58c.

📒 Files selected for processing (4)
  • .gitignore (1 hunks)
  • CHANGES.md (1 hunks)
  • build/llm/README.md (2 hunks)
  • pyproject.toml (1 hunks)

Walkthrough

The changes update documentation and build scripts to align file naming conventions with the standards from llmtxt.dev. Documentation files now describe the new naming scheme, and build commands generate output files using the revised names (llms.txt and llms-full.txt instead of the previous llms-ctx.txt variants). No functional code or control flow was altered.

Changes

Files/Paths Change Summary
CHANGES.md Added a note in the unreleased section about adopting the llmtxt.dev naming convention for output files.
build/llm/README.md Added "Introduction" and "What's Inside" sections; described the new file naming and contents.
pyproject.toml Updated build commands to generate and copy files using the new naming convention (llms.txt, llms-full.txt).
.gitignore Added ignore patterns for .txt files and cratedb-overview.md under build/llm/.

Possibly related PRs

Poem

🐇
New names for files, a tidy sweep,
Docs and scripts in sync now keep.
From ctx to plain, the change is small,
But standards matter, after all!
A hop, a skip, conventions met—
The neatest code, you’ll ever get!


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.

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 (3)
pyproject.toml (1)

168-170: Build tasks updated to use new naming convention
Aligns with CHANGES.md and the llmtxt.dev guidance.

Consider ensuring the build/llm directory exists before copying to avoid errors on a clean build:

- { shell = "cp src/index/cratedb-overview.md build/llm/" },
+ { shell = "mkdir -p build/llm && cp src/index/cratedb-overview.md build/llm/" },
CHANGES.md (1)

5-6: Clarify list phrasing
The bullet uses “vs.” which may imply contrast rather than inclusion. To make it explicit that both files are used, consider:

- - Naming things: Adhered to the naming convention of https://llmtxt.dev/hub
-   by using `llms.txt` vs. `llms-full.txt`.
+ - Naming things: Adhered to the naming convention of https://llmtxt.dev/hub
+   by using `llms.txt` and `llms-full.txt`.
build/llm/README.md (1)

14-19: Document the directory contents
The “What’s inside” section clearly enumerates the three key files.

  • Title-case the heading (“What’s Inside”) for consistency with other top‐level headings.
  • In the first bullet, streamline “generating llms.txt from” to “generating llms.txt” for clarity.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...# What's inside - cratedb-overview.md: The source file for generating `llms.tx...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...generating llms.txt from. - llms.txt: Standard llms.txt file. - `llms-full....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndard llms.txt file. - llms-full.txt: Full llms.txt file, including the "Op...

(UNLIKELY_OPENING_PUNCTUATION)

📜 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 1aa83d1.

📒 Files selected for processing (3)
  • CHANGES.md (1 hunks)
  • build/llm/README.md (2 hunks)
  • pyproject.toml (1 hunks)
🧰 Additional context used
🪛 LanguageTool
build/llm/README.md

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...# What's inside - cratedb-overview.md: The source file for generating `llms.tx...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...generating llms.txt from. - llms.txt: Standard llms.txt file. - `llms-full....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndard llms.txt file. - llms-full.txt: Full llms.txt file, including the "Op...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (1)
build/llm/README.md (1)

3-4: Add Introduction section
Provides valuable context for the purpose of the llms.txt files.

@amotl amotl force-pushed the naming-things branch from 1aa83d1 to 749244c Compare May 8, 2025 19:30
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: Replace bare URL with a Markdown link.

Markdown style guidelines (e.g., MD034 no-bare-urls) discourage bare URLs. Consider using a descriptive link instead of https://llmtxt.dev/hub inline.

Apply this diff:

- - Naming things: Adhered to the naming convention of https://llmtxt.dev/hub
+ - Naming things: Adhered to the naming convention of [LLM Text Hub](https://llmtxt.dev/hub)
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

5-5: 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 1aa83d1 and 749244c.

📒 Files selected for processing (4)
  • .gitignore (1 hunks)
  • CHANGES.md (1 hunks)
  • build/llm/README.md (2 hunks)
  • pyproject.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .gitignore
🚧 Files skipped from review as they are similar to previous changes (1)
  • pyproject.toml
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGES.md

5-5: Bare URL used
null

(MD034, no-bare-urls)

🪛 LanguageTool
build/llm/README.md

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...# What's inside - cratedb-overview.md: The source file for generating `llms.tx...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...generating llms.txt from. - llms.txt: Standard llms.txt file. - `llms-full....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndard llms.txt file. - llms-full.txt: Full llms.txt file, including the "Op...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (2)
build/llm/README.md (2)

3-4: Introduction section added correctly.

The new "## Introduction" header and content clearly explain the purpose of llms.txt and align with the naming updates. Good addition.


14-19: "What's inside" section outlines file contents effectively.

The list of cratedb-overview.md, llms.txt, and llms-full.txt is concise and informative. Aligns with the PR objective.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...# What's inside - cratedb-overview.md: The source file for generating `llms.tx...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...generating llms.txt from. - llms.txt: Standard llms.txt file. - `llms-full....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndard llms.txt file. - llms-full.txt: Full llms.txt file, including the "Op...

(UNLIKELY_OPENING_PUNCTUATION)

@amotl amotl force-pushed the naming-things branch from 749244c to be0882a Compare May 8, 2025 19:36
@amotl amotl requested a review from bmunkholm May 9, 2025 10:59
@amotl amotl force-pushed the naming-things branch from be0882a to c46f95a Compare May 9, 2025 11:00
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)
build/llm/README.md (1)

16-18: Remove trailing periods from list items for consistency
To keep list items concise and adhere to the straightforward language style (per your earlier learnings), drop the final period on each bullet.

- - `cratedb-overview.md`: The source file for generating `llms.txt`.
+ - `cratedb-overview.md`: The source file for generating `llms.txt`
- - `llms.txt`: Standard `llms.txt` file.
+ - `llms.txt`: Standard `llms.txt` file
- - `llms-full.txt`: Full `llms.txt` file, including the "Optional" subsection.
+ - `llms-full.txt`: Full `llms.txt` file, including the "Optional" subsection
🧰 Tools
🪛 LanguageTool

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...# What's Inside - cratedb-overview.md: The source file for generating `llms.tx...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~17-~17: Loose punctuation mark.
Context: ... for generating llms.txt. - llms.txt: Standard llms.txt file. - `llms-full....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndard llms.txt file. - llms-full.txt: Full llms.txt file, including the "Op...

(UNLIKELY_OPENING_PUNCTUATION)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 749244c and c46f95a.

📒 Files selected for processing (4)
  • .gitignore (1 hunks)
  • CHANGES.md (1 hunks)
  • build/llm/README.md (2 hunks)
  • pyproject.toml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CHANGES.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • .gitignore
  • pyproject.toml
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: amotl
PR: crate/about#0
File: :0-0
Timestamp: 2025-04-16T14:16:33.171Z
Learning: When creating content for an `llms.txt` file (following the llmstxt.org specification), consistent and straightforward language takes precedence over stylistic variation since the primary audience is language models rather than human readers.
Learnt from: amotl
PR: crate/about#0
File: :0-0
Timestamp: 2025-04-16T14:20:35.508Z
Learning: When creating content for an `llms.txt` file (following the llmstxt.org specification), consistent and straightforward language takes precedence over stylistic variation since the primary audience is language models rather than human readers.
Learnt from: amotl
PR: crate/about#0
File: :0-0
Timestamp: 2025-04-16T14:20:35.508Z
Learning: When creating content for an `llms.txt` file (following the llmstxt.org specification), consistent and straightforward language takes precedence over stylistic variation since the primary audience is language models rather than human readers.
build/llm/README.md (3)
Learnt from: amotl
PR: crate/about#0
File: :0-0
Timestamp: 2025-04-16T14:16:33.171Z
Learning: When creating content for an `llms.txt` file (following the llmstxt.org specification), consistent and straightforward language takes precedence over stylistic variation since the primary audience is language models rather than human readers.
Learnt from: amotl
PR: crate/about#0
File: :0-0
Timestamp: 2025-04-16T14:20:35.508Z
Learning: When creating content for an `llms.txt` file (following the llmstxt.org specification), consistent and straightforward language takes precedence over stylistic variation since the primary audience is language models rather than human readers.
Learnt from: amotl
PR: crate/about#0
File: :0-0
Timestamp: 2025-04-16T14:20:35.508Z
Learning: When creating content for an `llms.txt` file (following the llmstxt.org specification), consistent and straightforward language takes precedence over stylistic variation since the primary audience is language models rather than human readers.
🪛 LanguageTool
build/llm/README.md

[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...# What's Inside - cratedb-overview.md: The source file for generating `llms.tx...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~17-~17: Loose punctuation mark.
Context: ... for generating llms.txt. - llms.txt: Standard llms.txt file. - `llms-full....

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndard llms.txt file. - llms-full.txt: Full llms.txt file, including the "Op...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (2)
build/llm/README.md (2)

3-4: Approve new Introduction section
The added “## Introduction” header clearly scopes the document and aligns with the llmstxt.dev naming convention.


14-14: Approve new What’s Inside section
The “## What’s Inside” header effectively introduces the list of generated files and follows the updated naming scheme.

for ad hoc conversations about CrateDB


[LLMs.txt Hub]: https://llmtxt.dev/hub

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ddi you mean to include this link here?


## Unreleased
- Chore: Removed `sponge` command in `poe build`
- Naming things: Adhered to the naming convention of [LLMs.txt Hub]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to include this link here?

Yes, it is used here. Thanks.

@amotl amotl force-pushed the naming-things branch from c46f95a to f9fc58c Compare May 9, 2025 13:27
@amotl amotl merged commit d7180a0 into main May 9, 2025
3 checks passed
@amotl amotl deleted the naming-things branch May 9, 2025 13:27
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.

2 participants