Skip to content

docs: sentence-case README headings, drop dashes and repeats (VOYG-398) - #9

Merged
yamarkov merged 1 commit into
mainfrom
voyg-398-remove-slop
Oct 19, 2026
Merged

yamarkov merged 1 commit into
mainfrom
voyg-398-remove-slop

Conversation

@yamarkov

@yamarkov yamarkov commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Removes the AI-writing tells that the VOYG-396 audit found in the dev-tools README. The edits add no facts. Code blocks, URLs and anchors are unchanged.

What changed

  • Headings use sentence case ("Quick start", "Retry behavior"). GitHub anchors are lowercase, so every link still resolves.
  • The -- and em dashes became colons and full stops.
  • The key-recovery paragraph appeared twice. The Quick start copy is gone, and the voygr recover section keeps the full text.
  • "Exits with code 1 if any check in the batch fails" appeared twice. The Batch mode section keeps it.
  • "automatically" and the "making it easy to pipe" rider are gone.

The README already used American spelling, so it needed no spelling changes.

Stop-slop scores (/50)

Page Audit (before) Blind run, main Blind run, this PR
README.md 41 37 43
Repo description (proposed) 34 30 43

A separate model scored the blind columns. It got the main and PR versions under shuffled labels and did not know which was which.

Proposed repo description

Not applied. The repo setting is unchanged.

Old: "Tools for the developers and agents using VOYGR APIs"

New: "CLI and Python client for the VOYGR Business Validation API."

The new text is the README's first line with "VOYGR" added.

Checks

  • pytest: 77 passed (the same before and after; no code changed).
  • A throwaway script compared the README with main. Results:
    • Fenced code blocks are identical.
    • There are no dashes used as connectors in prose.
    • There are no title-case headings.
    • Every anchor resolves.
  • A separate reviewer compared old and new text for added, dropped or changed facts. It found one line that could be read as "the CLI retries every request", and I reworded it.
  • pyproject.toml uses this README as the PyPI description, so the next release publishes the new text.

Refs VOYG-398, VOYG-396.

🤖 Generated with Claude Code

Uses sentence case for headings, swaps the "--" and em dashes for colons
and full stops, removes the second copy of the key-recovery paragraph and
the duplicate exit-code line, and drops "automatically". Anchors are
unchanged. No facts added.

Refs VOYG-398

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: multica-agent <github@multica.ai>
@greptile-apps

greptile-apps Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] This documentation-only PR appears safe to merge.

Summary

This PR cleans up README.md without changing code.

  • The README guides readers with sentence-case headings and shorter explanations.

No actionable issues found.

Reviews (1) · Last reviewed commit: "docs(readme): sentence-case headings, dr..." · Reviewed by Greptile

@yamarkov
yamarkov merged commit 686b0d7 into main Oct 19, 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.

2 participants