SKILL.md
eli5
Explain like I'm someone who knows nothing about this code: one sentence, then one part at a time, until the whole picture is on screen and the reader already knows every part of it.
A reader who knows nothing cannot take in a diagram. They can take in two boxes and an arrow. So the canvas starts with two boxes and grows. The whole picture is the last thing they see, not the first, and by then it holds nothing new.
You write one graph document. Its views are the growing pictures, its walkthrough plays them in order, and PR Lens draws them. The reader opens a link and presses play. There is no page, no list, no paragraph.
What you need
The PR Lens manual and its reference pages. The PR Lens CLI prints both. Run npx @coldtea/pr-lens-cli@latest skill, then npx @coldtea/pr-lens-cli@latest skill references, and read both before your first document. The manual's rules hold here except where this page marks an Override.
Operating manual
- Write the answer first. Read the code until you can say what it does for a person, in under 48 characters, because the sentence is also a walkthrough heading and a heading stops at 48. Count them.
- For a feature or a command: "When you ___, this code ___." Example: "When you hit send, it emails everyone."
- For a whole codebase: what the product is for. Example: "BestRegards sends newsletters for you." The sentence is about the product, not one path through it.
Override, summary. The sentence is also the document
summary. The reference wants a paragraph about a change; eli5 wants this sentence.