Smell Check docs

Overlay

Keep a short file in the consuming project. Default dest: docs/smellcheck.md. Point at this package, then only:

  • Pronouns per surface (and who speaks on a filing)
  • Terms that pass the applicability heuristic *here*, with one-line why
  • Protected maxims / testimony
  • Genre extras that are house law

Do not fork core.md. Do not restate the hard bans.

This package protects:

  • Earn the word.
  • Spray the prose, not the author.
  • Have you smell-checked that?

Site and README speak as the product (Smell Check / it). No corporate we. No builder I.

Skeleton

Copy examples/overlay.md to docs/smellcheck.md and fill the blanks. A filled card for this package: examples/overlay.smellcheck.md.

# Smell Check overlay

House overlay on `smellcheck`. Core bans live in the package. This file
is only what is true here.

Do not restate the hard bans. Do not fork `core.md`.

## Pronouns

- Essays / personal drafts:
- Landing / marketing:
- Outreach:
- Filings (who speaks):
- Papers:

## Terms usually allowed here (not exhaustive)

| Term | Why it earns its keep |
| --- | --- |
| | |

## Protected lines

This package already protects:

- Earn the word.
- Spray the prose, not the author.
- Have you smell-checked that?

Add house maxims or verbatim testimony below.

## Genre extras (house law only)

After install

Wire the repo on Get started, then fill this file from the skeleton. Point "Full rules" at node_modules/smellcheck/rules/core.md.

Get started · Files