Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: added action to generate llms.txt #701

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

chartotu19
Copy link

This PR adds an open-source action to generate necessary llms files to the docs as per the standard.

  • Added demodrive-ai/llms-txt-action@v1 action
  • Added --dirty flag in gh-deploy to keep the generated files.

Issue resolved by this Pull Request:
Resolves #699

Checklist:

  • Documentation has been updated, if necessary.
  • Examples have been added, if necessary.
  • Tests have been added, if necessary.

Copy link

mergify bot commented Jan 7, 2025

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert)(?:\(.+\))?(!)?:

@chartotu19 chartotu19 changed the title added action to generate llms.txt ci: added action to generate llms.txt Jan 7, 2025
@dolfim-ibm dolfim-ibm self-requested a review January 7, 2025 19:05
@dolfim-ibm
Copy link
Contributor

@chartotu19 it looks interesting, thanks for adding your action. Before enabling it, could you please pin the exact release sha1?

@chartotu19
Copy link
Author

@chartotu19 it looks interesting, thanks for adding your action. Before enabling it, could you please pin the exact release sha1?

@dolfim-ibm Thanks for the responding! I am not sure exactly what you mean?

In the action releases, v1 points to v1.0.2 which points ad72069

should I use

demodrive-ai/llm-txt-action@ad720693843126e6a73910a667d0eba37c1dea4b

instead of

demodrive-ai/llm-txt-action@v1

@dolfim-ibm
Copy link
Contributor

yes, this is what I meant

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.

LLM friendly docs
2 participants