`docs` | Auto-generate `llms.txt` · vueuse/vueuse#4824

(7 commentaires) (7 réactions) (0 assignés)TypeScript (18 007 stars) (2 269 forks)batch import

documentationgood first issue

Description

Clear and concise description of the problem

As a developer using VueUse, I want to provide LLMs (local or API-based) with structured, easy-to-ingest documentation via a standard /llms.txt file, so that I can improve prompt-based tooling, contextual embeddings, and agent access to VueUse APIs.

Happy to contribute a PR if maintainers support this direction.

Alternative

Copy/Paste

Additional context

llms.txt is designed to be human- and LLM-readable, minimal, and works well with fixed-token contexts.

Validations

Follow our Code of Conduct
Read the Contributing Guidelines.
Read the docs.
Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

Guide contributeur

Stack technique: typescriptvue
Domaine: documentation
Type d'issue: feature
Difficulté: 3
Temps estimé: half day
Statut d'activité: fresh
Clarté: clear
Prérequis: VueUse project structureDocumentation generation toolsllms.txt format
Accessibilité débutant: 75
Direction de recherche: Start by examining the VueUse documentation setup, typically in the `docs` directory with a VitePress configuration. Look for existing build scripts that generate static files (e.g., navigation). Then create a new script to generate an `llms.txt` file that lists key pages and their descriptions, following the llms.txt standard. Test the output locally and open a draft PR for early feedback. Review any comments on the issue for additional requirements.