visual-explainer
Visual explainer
Explain the mechanism so a reader unfamiliar with the implementation can follow it from their own code to the outcome. This is the shared visual and narrative style for the repository; it does not grant permission to implement a fix or publish a PR. Follow the active workflow in AGENTS.md. Write in the user's language for personal explanations and the repository's language for PR descriptions unless directed otherwise.
Establish what is being explained
Read the issue or request, relevant source/API docs, and available reproduction or validation evidence. For a PR, identify its base and head and inspect both versions where behavior changed. Distinguish the reported symptom, confirmed cause, proposed solution and implemented result. If the fix is only proposed, label it as proposed throughout; do not present predictions as results. Use one representative example throughout the explanation. Name omitted setup and define terms when the reader first needs them. Do not infer an API from a diagram or an old draft.