Skip to content

README and docs: plain, professional wording - #5

Merged
arsalann merged 1 commit into
mainfrom
arsalann/readme-plain-wording
Oct 5, 2026
Merged

arsalann merged 1 commit into
mainfrom
arsalann/readme-plain-wording

Conversation

@arsalann

@arsalann arsalann commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Linear: BRU-6682

Follow-up to #4. Replaces marketing phrasing with direct descriptions. No change to commands, links or behaviour.

What changed

  • README.md
    • Top: the tagline and the "without the confident wrong number" hook are replaced by a plain description of startup-data-kit.
    • "Try it in 2 minutes" is renamed "Try it with sample data", and the note now says what --full-refresh does.
    • "What is here", the Slack paragraph and "Or copy the folder" are reworded without slang.
    • "What these are written to prevent" is renamed "What the skills cover" and reworded.
    • Smaller wording fixes in the upstream, credentials and contributing sections.
  • resources/startup-data-kit/README.md: "The joins are where the value is" becomes "Questions that span domains", plus related wording.
  • ai-coding-spend/sample-data/README.md: the heading becomes "Try it", and the "two traps" line is reworded.
  • CONTRIBUTING.md: the opening paragraph is reworded, and "genuinely" is removed twice.
  • demo/ai-coding-spend.tape: the header comment no longer says "2 minutes". This comment is not shown in the GIF, so the GIF is unchanged.

Verification

  • ./tests/check.py: ok, 0 warnings.

Not changed

  • The skill files that instruct the agent: the "Traps" headings in analysis.md, and the investor line in revenue-analytics/SKILL.md. These are agent instructions, not user docs.

🤖 Generated with Claude Code

Replace marketing phrasing in the README, the startup-data-kit README, the
sample-data README and CONTRIBUTING.md with direct descriptions. No change to
commands, links or behaviour.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@arsalann
arsalann merged commit 3732474 into main Oct 5, 2026
5 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