@avi2dg/checks 0.38.0 → 0.38.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 Every release of `@avi2dg/checks`, newest first, written by the release from its conventional commits.
 
+## 0.38.1
+
+Released 2026-10-11.
+
+### Fixes
+
+- **docs:** derive README what-you-see line from source, make Where things are optional [#142](https://github.com/avi2d/checks/pull/142)
+
 ## 0.38.0
 
 Released 2026-10-10.

package/dist/templates/readme.md

@@ -13,7 +13,8 @@ To install <name>:
 1. <step>
 1. <step>
 
-<What you see when it worked.>
+<What you see when it worked, written only from what the source shows.>
+<Leave this line out when the source shows nothing.>
 
 ## <Everyday task, verb first, or what the reader looks up>
 
@@ -26,6 +27,8 @@ To <do the task>:
 
 ## Where things are
 
+<Leave this section out when there is no path worth mapping yet.>
+
 | Path | What it holds |
 | --- | --- |
 

package/docs/gates/checks-docs.md

@@ -201,7 +201,7 @@ With one it is that commit against its parent, or against the empty tree for a r
 
 ```
 docs: 6 violation(s):
-  README.md:1: lacks `## Where things are`
+  README.md:1: lacks `## Before you begin`
   README.md:12: carries `;`, a semicolon. Use two sentences
   README.md:14: carries `former`, a report about the past. Say what is true now, and leave what changed to the changelog, a commit message or a decision record
   README.md:20: names `scripts/bild.ts`, which is not in the repository

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avi2dg/checks",
-  "version": "0.38.0",
+  "version": "0.38.1",
   "description": "Deterministic checks shared across a set of TypeScript repositories",
   "license": "MIT",
   "repository": {

package/src/docs/doc-templates.ts

@@ -67,13 +67,21 @@ export const TEMPLATES: Readonly<Record<Kind, Template>> = {
     lead: ["<The concept in two to four sentences: what this is, who it is for, why you would use it.>"],
     sections: [
       BEFORE_YOU_BEGIN,
-      fixed("Install", REQUIRED, ["To install <name>:", "", "1. <step>", "1. <step>", "", "<What you see when it worked.>"]),
+      fixed("Install", REQUIRED, [
+        "To install <name>:",
+        "",
+        "1. <step>",
+        "1. <step>",
+        "",
+        "<What you see when it worked, written only from what the source shows.>",
+        "<Leave this line out when the source shows nothing.>",
+      ]),
       open("<Everyday task, verb first, or what the reader looks up>", "any", REQUIRED, [
         ...STEPS,
         "",
         "<Or, for what the reader looks up, a table or a list with no steps.>",
       ]),
-      fixed("Where things are", REQUIRED, ["| Path | What it holds |", "| --- | --- |"]),
+      fixed("Where things are", optional("there is no path worth mapping yet"), ["| Path | What it holds |", "| --- | --- |"]),
       TROUBLESHOOTING,
       RELATED_TOPICS,
     ],