Naming things: Adhere to the naming convention of https://llmtxt.dev/hub#11
Naming things: Adhere to the naming convention of https://llmtxt.dev/hub#11
Conversation
|
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 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. 📒 Files selected for processing (4)
WalkthroughThe 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 ( Changes
Possibly related PRs
Poem
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. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
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/llmdirectory 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.txtfrom” to “generatingllms.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: ...generatingllms.txtfrom. -llms.txt: Standardllms.txtfile. - `llms-full....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndardllms.txtfile. -llms-full.txt: Fullllms.txtfile, including the "Op...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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.
There was a problem hiding this comment.
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/hubinline.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
📒 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.txtand 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, andllms-full.txtis 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: ...generatingllms.txtfrom. -llms.txt: Standardllms.txtfile. - `llms-full....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndardllms.txtfile. -llms-full.txt: Fullllms.txtfile, including the "Op...(UNLIKELY_OPENING_PUNCTUATION)
There was a problem hiding this comment.
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 generatingllms.txt. -llms.txt: Standardllms.txtfile. - `llms-full....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ndardllms.txtfile. -llms-full.txt: Fullllms.txtfile, including the "Op...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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 |
There was a problem hiding this comment.
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] |
There was a problem hiding this comment.
Did you mean to include this link here?
Yes, it is used here. Thanks.
https://llmtxt.dev/hub uses
llms.txtandllms-full.txt. Let's use the same convention.