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

LLM-text discoverability #1012

Open
clearfram3 opened this issue Dec 14, 2024 · 4 comments
Open

LLM-text discoverability #1012

clearfram3 opened this issue Dec 14, 2024 · 4 comments

Comments

@clearfram3
Copy link

clearfram3 commented Dec 14, 2024

Describe the problem

It's hard to find the LLM-texts—the only link to "https://svelte.dev/docs/llms" is way down in the advent of svelte blog post

Describe the proposed solution

  1. "LLM-texts" should be added to the docs-dropdown of the app-bar
  2. The number of tokens for LLM-text file should be listed to the right of specific file name, but before the rest of the description
  3. Each description should list the date it was most recently updated
  4. The relevant LLM-text file/url should at least be mentioned in the 'Overview' page of each package

Importance

nice to have

@dummdidumm
Copy link
Member

It's listed in the docs overview page https://svelte.dev/docs

We could add it to each overview page (i.e https://svelte.dev/docs/svelte) but more would be too much IMO

@dummdidumm dummdidumm transferred this issue from sveltejs/svelte Dec 14, 2024
@Rich-Harris
Copy link
Member

There's also a directory at /llms.txt — the whole point of having a convention like this is that you don't need to signpost it in a bunch of places.

What would be the purpose of including the date it was updated?

@clearfram3
Copy link
Author

Your point on convention is great—having redundancy is also good. The Discord server is mentioned in /docs even though its icon is where you would conventionally find it—in the appbar. Redundancy ensures ease of discovery and less questions in the Discord haha.

Including the date or version number of the conglomerated docs lets people know how up-to-date it is.

Last thought: on /docs the actual links to Sv and SvKit docs is just the words, but everything else gets a big block. Maybe just odd to me tho.

Y'all have done a fantastic job on of all this—thank you for the consistent, awesome effort!

@veeterAI
Copy link

I think the publishing date is important because Svelte is an evolving code-base.

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

No branches or pull requests

4 participants