Skip to content

docs: add a bold Motivation label to the reason line in module docs - #1230

Merged
43081j merged 1 commit into
e18e:mainfrom
maksimgm:docs/motivation-label
Nov 11, 2026
Merged

43081j merged 1 commit into
e18e:mainfrom
maksimgm:docs/motivation-label

Conversation

@maksimgm

Copy link
Copy Markdown
Contributor

Closes #1152

Prefixes the reason line under each doc's title with a bold **Motivation:** label, as discussed in the issue. The change covers existing docs that already open with a reason, not just the four from #1150.

Changes

  • docs/templates/module.md: the template's reason line now starts with **Motivation:**
  • CONTRIBUTING.md: the documentation guideline mentions the label
  • 20 docs that open with a reason line now carry the label: bcrypt, better-auth-cli, cpx, crypto-js, css-loader, eslint-plugin-jsx-a11y, express, form-data, gray-matter, http-proxy, istanbul-lib-coverage, js-yaml, lru-cache, mockdate, rollup-plugin-terser, tsc, tsup, uri-js, utf8, wait-for-expect

Only the label is added. The wording of each line is unchanged.

Left unchanged

These docs open with something other than a reason, so a Motivation: label would read oddly. They could get a proper reason line in a follow-up:

  • Hub pages: fetch, schema-validation
  • Openings that describe what the package does (sometimes with the reason in a later sentence): classnames, is-path-in-cwd, is-path-inside, is-utf8, jszip, mississippi, pako, path-root, readable-stream, timezone-support, tweetnacl
  • Opens with a callout: cross-spawn

Docs that go straight to a ## section have no reason line, so they're also untouched.

@43081j
43081j merged commit 33d4a7e into e18e:main Nov 11, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: use a bold motivation label for the reason line in module docs

2 participants