Skip to content

docs(overview): fewer boxes and a clearer lead on the Overview - #555

Merged
aicayzer merged 2 commits into
mainfrom
docs/overview-copy
Oct 21, 2026
Merged

aicayzer merged 2 commits into
mainfrom
docs/overview-copy

Conversation

@aicayzer

Copy link
Copy Markdown
Contributor

Summary

The Overview opened with two lines that said the same thing, then sixteen cards, which read as a wall of navigation. It now has one lead, a short paragraph on what Marfa does, two cards to start from, and short link lists for building, running and the reference. The Introduction shows its diagram before the list of uses.

Changes

  • Overview: description shortened to one sentence; a paragraph says what an instance holds and who reaches it; Start here has two cards; Build on Marfa and Run Marfa each have one line and a list; Reference is one paragraph of links.
  • Introduction: "How it fits together", with its diagram, moves above "What you can do with Marfa".

Testing

  • pnpm test (364) passes.
  • Looked at both pages in the browser at desktop width.

Notes for reviewers

Checks only: wording and order, with every claim already on the pages it links to.

Checklist

  • Follows STYLE.md
  • Tests pass

@aicayzer aicayzer left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: checks only

Summary. Wording and order on the Overview and Introduction, every claim already on the pages linked; looked at both in the browser.


Checked by the orchestrating session on claude-opus-5-5. This review may contain mistakes.

@aicayzer
aicayzer merged commit 13243e4 into main Oct 21, 2026
3 checks passed
@aicayzer
aicayzer deleted the docs/overview-copy branch October 21, 2026 16:17
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