-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
Description
Documentation is
- Missing
- Outdated
- Confusing
- Not sure?
Explain in Detail
I suggest adding Vite documentation for LLMs in Markdown format, which will be available at https://vite.dev/llms.txt
This documentation format for LLMs has already been adopted by many projects, including Svelte - https://svelte.dev/llms.txt
It would be nice to have an LLM-friendly documentation format like this one for people: https://vite.dev/guide/features.html
And this one for LLM in pure Markdown without any HTML, CSS and everything unnecessary: https://vite.dev/guide/features.md
Your Suggestion for Changes
We can create a basic llms.txt
with just a description and links to the documentation (regular, not for LLMs) as in FastHTML:
# FastHTML
> FastHTML is a python library which brings together Starlette, Uvicorn, HTMX, and fastcore's `FT` "FastTags" into a library for creating server-rendered hypermedia applications.
Important notes:
- Although parts of its API are inspired by FastAPI, it is *not* compatible with FastAPI syntax and is not targeted at creating API services
- FastHTML is compatible with JS-native web components and any vanilla JS library, but not with React, Vue, or Svelte.
## Docs
- [FastHTML quick start](https://docs.fastht.ml/path/quickstart.html.md): A brief overview of many FastHTML features
- [HTMX reference](https://raw.githubusercontent.com/path/reference.md): Brief description of all HTMX attributes, CSS classes, headers, events, extensions, js lib methods, and config options
## Examples
- [Todo list application](https://raw.githubusercontent.com/path/adv_app.py): Detailed walk-thru of a complete CRUD app in FastHTML showing idiomatic use of FastHTML and HTMX patterns.
## Optional
- [Starlette full documentation](https://gist.githubusercontent.com/path/starlette-sml.md): A subset of the Starlette documentation useful for FastHTML development.
This is a basic example that can be implemented quickly and easily
But you can do better thanks to the automatic generation of documentation for LLMs, as Svelte and Prisma did:
Reproduction
No response
Steps to reproduce
No response