feat: add llms.txt workflow #2032

jcstein · 2025-05-13T13:46:08Z

Overview

Resolves #1962

coderabbitai · 2025-05-13T13:46:16Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
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 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.

github-actions · 2025-05-13T13:47:20Z

PR Preview Action v1.6.1
🚀 View preview at https://celestiaorg.github.io/docs-preview/pr-2032/
Built to branch `main` at 2025-05-13 14:20 UTC. Preview will be ready when the GitHub Pages deployment is complete.

.github/workflows/generate_llms_txt.yml

jcstein · 2025-05-13T13:52:55Z

.github/workflows/generate_llms_txt.yml

+          node-version: 18
+
+      - name: Generate llms.txt
+        run: npx -y llmstxt gen https://docs.celestia.org/sitemap.xml > public/llms.txt


I realized this is using the site to build it, so wouldn't build it from the new content being changed/added. so maybe this should be a cron job 🤔

I think post-merge would be even better:

on: push: branches: - main # or 'master', whatever your default branch is paths: - docs/** # adjust these patterns to only match relevant changes - .github/workflows/generate_llms_txt.yml

i think /docs doesn't exist. would the post-merge work still if the site hasn't built, since it's generating it from the built site?

I hadn't noticed/focused on it. I think you are correct.
In this case, removing this "paths" key altogether should be fine, really, because the cmd is reading from the deployed website.

Also, I don't know how deployment is working for now, but I am guessing it takes a moment for it to be live after merge, right?

So I got 2 decent solutions to ponder:

or

let's do sleep for 10 mins then build it, should only take 5 mins max to build but better to be on safe side

…n permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

feat: add llms.txt workflow

c4a4043

github-advanced-security bot found potential problems May 13, 2025

View reviewed changes

.github/workflows/generate_llms_txt.yml Fixed Show fixed Hide fixed

jcstein self-assigned this May 13, 2025

jcstein commented May 13, 2025

View reviewed changes

jcstein and others added 2 commits May 13, 2025 09:55

feat: use cron job

ae4af0e

Potential fix for code scanning alert no. 8: Workflow does not contai…

dfe742c

…n permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

feat: add llms.txt workflow #2032

Are you sure you want to change the base?

feat: add llms.txt workflow #2032

Uh oh!

Conversation

jcstein commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Uh oh!

coderabbitai bot commented May 13, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions bot commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch main at 2025-05-13 14:20 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

Uh oh!

jcstein May 13, 2025

Choose a reason for hiding this comment

Uh oh!

jcstein May 13, 2025

Choose a reason for hiding this comment

Uh oh!

gbarros May 13, 2025

Choose a reason for hiding this comment

Uh oh!

jcstein May 13, 2025

Choose a reason for hiding this comment

Uh oh!

gbarros May 13, 2025

Choose a reason for hiding this comment

Uh oh!

gbarros May 13, 2025

Choose a reason for hiding this comment

Uh oh!

jcstein May 13, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jcstein commented May 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented May 13, 2025 •

edited

Loading

Built to branch `main` at 2025-05-13 14:20 UTC.
Preview will be ready when the GitHub Pages deployment is complete.