vueuse/vueuse

`docs` | Auto-generate `llms.txt`

Open

#4,824 opened on 2025年6月16日

GitHub で見る
 (7 comments) (7 reactions) (0 assignees)TypeScript (18,007 stars) (2,269 forks)batch import
documentationgood first issue

説明

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.

Suggested solution

llms.txt

Alternative

Copy/Paste

Additional context

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

Validations

コントリビューターガイド

技術スタック
typescriptvue
領域
documentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
VueUse project structureDocumentation generation toolsllms.txt format
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
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.
`docs` | Auto-generate `llms.txt` · vueuse/vueuse#4824 | Good First Issue