docs: enhance LLM instructions (qwik-concepts.md) for AI editors#8194
Open
sebacc92 wants to merge 1 commit intoQwikDev:llm-instructfrom
Open
docs: enhance LLM instructions (qwik-concepts.md) for AI editors#8194sebacc92 wants to merge 1 commit intoQwikDev:llm-instructfrom
sebacc92 wants to merge 1 commit intoQwikDev:llm-instructfrom
Conversation
… and environment variable sections, and fix a typo.
|
Member
|
@sebacc92 please run prettier on the file to fix the lint error. I think the other error is transient |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

docs: enhance LLM instructions (qwik-concepts.md) for AI editors
What is it?
Description
This PR significantly improves the
qwik-concepts.mdfile (used as context for LLMs/AI Agents like Cursor, Antigravity, and Copilot).Motivation:
Current LLMs often "hallucinate" React patterns (like
useEffectoruseState) when writing Qwik code. This update provides a stricter "System Prompt" style to force the correct mental model.Changes:
useEffect,useState, and nested Stores.useEffect->useTask$).useVisibleTask$should be avoided in favor ofuseTask$oruseOnDocumentto preserve Resumability.classvsclassNameandsync$events.This incorporates feedback from previous discussions (PR #7729) to make the instructions robust for autonomous agents.
Checklist
pnpm change(Skipped as this is a docs-only change for starters)