docs(profile): dedupe and tighten the bottom half of README#44
Merged
Conversation
Cuts 354 → 206 lines (-42%) by collapsing overlapping sections. No content removed in spirit; ~5 sections that all answered the same question merged into one each. What changed: - "What is Cycles?" + "What is Runcycles?" + "Quick mental model" + "The ecosystem" → single "## What this is" section. A first-time reader doesn't need the same definition four ways. - "Typical use cases" + "Who Runcycles is for" + "Where Runcycles fits" + "When to use Runcycles" → single "## Who it's for" section. Same reader question answered in one place. - "## How it works" tightened — the diagram + Try-it snippets at the top already showed this; the section now references the diagram and states the loop in one sentence. - "## What Runcycles enforces" converted from 5 sub-headings into a bulleted list. Same content, ~3x denser. - "## Status" gained a CHANGELOG link so it's load-bearing instead of decorative. What was dropped (deliberately): - Mid-page "👉 Learn more: runcycles.io" CTA at line 131 — it sat before 220 more lines of content, reading as a false page-end. - Web3 / EVM / "blockchain transactions" mentions in "Where Runcycles fits" + the defensive "Web3 is one surface area, not a requirement" one-liner. Not active product positioning; reads as holdover. - Wrong docs URL on the old "Learn more" line (runcycles.github.io/docs → fixed to the canonical runcycles.io). What was kept verbatim or near-verbatim: - Top half (lines 1-130): badges, hook, value-prop bullets, CTA links, architecture diagram, GIF demo, Try-it MCP+Python snippets, full Start-here repo list. Untouched. - "Why Runcycles exists" — distinct motivation, kept as-is (slightly tightened from 11 short lines to 2 paragraphs). - "What Runcycles is not" — orthogonal differentiator, useful, kept. - "Design principles" — short and load-bearing, kept verbatim.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cuts the org profile README from 354 → 206 lines (-42%) by collapsing overlapping sections. No content removed in spirit; ~5 sections that all answered the same question are merged into one each.
Why this PR
The bottom half had grown into ~14 sections with substantial overlap. Specifically:
A first-time visitor doesn't read 354 lines on a profile README — they skim. Cutting the redundancy makes the surviving prose actually land.
What changed
What was dropped
What was kept verbatim
Test plan