Skip to content

Added LLM-digestible documentation and sample .cursorrules file #49

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

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

chriscarrollsmith
Copy link
Contributor

@chriscarrollsmith chriscarrollsmith commented Nov 26, 2024

  • Added cursorrules.txt file as a downloadable static asset
  • Added a code block in index.qmd that generates an llms.txt file with the full project documentation
    • Gets all documentation file paths from _quarto.yml
    • Gets the text content of all the documentation files and replaces the Quarto header with a normal Markdown title
    • Concatenates the file contents and writes them to a single llms.txt file
  • Added download links for these files to the project docs

@chriscarrollsmith chriscarrollsmith linked an issue Nov 26, 2024 that may be closed by this pull request
4 tasks
@chriscarrollsmith chriscarrollsmith merged commit 4ab25bb into main Nov 26, 2024
2 checks passed
@chriscarrollsmith chriscarrollsmith deleted the 45-implement-llmstxt-standard branch November 26, 2024 16:13
@chriscarrollsmith chriscarrollsmith changed the title Added sample cursorrules and llms.txt generation script in index.qmd Added sample cursorrules file and auto-generated llms.txt file from a code block index.qmd Nov 26, 2024
@chriscarrollsmith chriscarrollsmith changed the title Added sample cursorrules file and auto-generated llms.txt file from a code block index.qmd Added LLM-digestible documentation and sample .cursorrules file Nov 26, 2024
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.

Implement llms.txt standard
1 participant