Skip to content

Add llms.txt to our website #2873

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.

Sign up for GitHub

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

Jump to bottom
Open
pokey opened this issue Mar 13, 2025 · 0 comments · May be fixed by #2922
Open

Add llms.txt to our website #2873

pokey opened this issue Mar 13, 2025 · 0 comments · May be fixed by #2922
Labels
documentation Improvements or additions to documentation

Comments

@pokey
Copy link
Member

pokey commented Mar 13, 2025

To help people trying to use an LLM to help them learn / use Cursorless, we should provide an llms.txt file that people can add as context. See:
@auscompgeek auscompgeek added the documentation Improvements or additions to documentation label Mar 14, 2025
pokey added a commit that referenced this issue May 23, 2025
@pokey
Add llms.txt
5a1c2ff 
- Fixes #2873

Co-Authored-By: sketch <[email protected]>
Change-ID: s2e8abba011e787cbk
@pokey pokey linked a pull request May 23, 2025 that will close this issue
Draft
pokey added a commit that referenced this issue May 23, 2025
@pokey
Add llms.txt generation following llms.txt specification
e80f601 
- Generate llms.txt as directory page with Core Documentation (root README) and Optional sections
- Generate llms-full.txt with complete user documentation concatenated
- Generate individual .md files for each documentation page in llms/ subdirectory
- Focus on user documentation only (exclude contributing docs)
- Follow llms.txt format specification from https://llmstxt.org/
- Integrate into build process via 'pnpm generate-llms' command

Fixes #2873

Co-Authored-By: sketch <[email protected]>
Change-ID: s30ae64e7cbc2b4fdk
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add llms.txt cursorless-dev/cursorless
2 participants
@auscompgeek @pokey