[📖] Provide llms.txt for documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 22.1k
- Forks
- 1.4k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 52
Description
Suggestion
Please provide an llms.txt that captures the important aspects of the documentation in an LLM readable format. This will make it easier for LLMs to understand the subtle differences between React and Qwik and will result in better code generation.
Standard: https://llmstxt.org/
A collection of other llms.txt docs: https://github.com/SecretiveShell/Awesome-llms-txt?tab=readme-ov-file
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the documentation and the llmstxt.org standard linked in the issue. Determine which documentation topics are important for distinguishing Qwik from React, then create an llms.txt that represents those topics in the requested format; it is done when the documentation is covered and the file follows the standard.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100