Skip to content

Conversation

@Killian-Aidalinfo
Copy link

Hello Quasar Team !

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • [] Documentation
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe: LLM integration enhancement

Does this PR introduce a breaking change?

  • Yes
  • No

The PR fulfills these requirements:

  • It's submitted to the dev branch (or v[X] branch)
  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix: #xxx[,#xxx], where "xxx" is the issue number)
  • It's been tested on a Cordova (iOS, Android) app
  • It's been tested on an Electron app
  • Any necessary documentation has been added or updated [in the docs]

Other information:

This PR introduces two files, llm.txt and llm-full.txt, to the Quasar website to improve its accessibility and usability by Large Language Models (LLMs):

  • llm.txt: Provides a high-level, curated overview of the site's structure and key resources, enabling LLMs to quickly understand and navigate the website's content.

  • llm-full.txt: Contains the complete documentation content in a single, markdown-formatted file, offering LLMs comprehensive access to all site information without parsing complex HTML structures.

So we could give llm-full.txt to the cursor or the claude code, with that in context/rag they're even more relevant in code generation.

Thank you ! Have a nice day.

Useful links :

LLM txt explication

Nuxt LLM example

@yusufkandemir
Copy link
Member

Hi, thanks for contributing 👏

However, this PR only contains a one-time creation of those files and no mechanism to keep them updated. If we add it as is, it will quickly get out of sync and will be more confusing than useful.

We would need to automate this process before merging this. We would also need to discuss a way to do this within the docs build process, using .md files, rather than scraping our own docs, to produce a more lightweight and faster way. Thanks again.

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.

2 participants