Skip to content

docs: sweep LLM slop from GUIDE and related docs - #8

Merged
makefunstuff merged 1 commit into
mainfrom
docs/slop-sweep
Sep 20, 2026
Merged

makefunstuff merged 1 commit into
mainfrom
docs/slop-sweep

Conversation

@makefunstuff

Copy link
Copy Markdown
Owner

Summary

Cut LLM connective tissue and duplicated material from the post-#7 docs, against docs/STYLE.md.

Per-file

File Action Why
docs/GUIDE.md rewrite (worst) Removed duplicated “Where each surface comes from” table; replaced §8 greenfield/clank essay with a short handoff table + pointer to TUTORIAL.md; tightened min_probability lab (kept measured bands); dropped “the whole point” / hedge just.
docs/CURSOR.md rewrite opening Removed rhetorical “honest question” framing; fixed banned simply.
docs/UX.md rewrite §5 Replaced sales “chat vs editor” framing with a factual comparison table; cut throat-clearing closer.
docs/MODEL.md light polish Dropped “not dollars but…” antithesis; dropped decorative by design.
docs/LANGUAGE.md light polish Dropped “the lesson taken from…” metaphor.
docs/ARCHITECTURE.md light polish “surprise worth knowing” → “detail that matters”.
docs/VERIFICATION.md light polish Dropped banned simply; “the lesson is” → “the shared cause is”.
site/README.md light polish Removed first-person “my copy of that sentence”.
README.md left alone Already tight after #7; STYLE grep clean.
docs/TUTORIAL.md left alone Already rewritten; STYLE grep clean; facts match README.
docs/ROADMAP.md left alone Only intentional Deliberately deferred heading.
docs/STYLE.md left alone Register itself.
PROTOCOL.md frozen / untouched No factual error found that required a protocol edit.
STATUS.md left alone Live “Next action” is dense but factual; dated log rows keep historical voice (including intentional deliberately / simply wrong).

Fact conflicts checked

Cross-checked README + PROTOCOL + crates/jev-core/src/rules.rs / config.rs:

  • Schema jev.rules/1, path .jev/rules/, fields applies_to + min_probability, env TYPESAFE_API_KEY, host api.typesafe.ai, wire system_oneconsistent across README, PROTOCOL, GUIDE, TUTORIAL, and code.
  • No applies_to / TYPESAFE_* / typesafe.ai spelling split found on main after docs: rewrite TUTORIAL.md as a short first-run path #7.
  • GUIDE §8 no longer invents APIs; it points at TUTORIAL.md and names clank only as an example shell ask-tool.

STYLE audit

Re-ran the docs/STYLE.md grep on changed files. Remaining hits are intentional: deliberately / by design naming missing fallbacks, unread settings, or the inline-completion removal; ROADMAP’s ## Deliberately deferred; dated STATUS log lines.

Out of scope

  • No code changes.
  • PROTOCOL.md not rewritten.
  • Not merged.

Remove the duplicated surfaces table and the greenfield/clank essay from GUIDE;
keep measured min_probability numbers. Rewrite CURSOR's rhetorical opening and
UX §5 sales framing. Light STYLE fixes in MODEL, LANGUAGE, ARCHITECTURE,
VERIFICATION, and site/README. PROTOCOL.md untouched.
@makefunstuff
makefunstuff merged commit b9f53e7 into main Sep 20, 2026
5 of 6 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.

1 participant