Skip to content

docs: simplify README getting-started paths - #152

Merged
nshki merged 1 commit into
mainfrom
cmcnally-readme-get-started-links
Oct 29, 2026
Merged

nshki merged 1 commit into
mainfrom
cmcnally-readme-get-started-links

Conversation

@cmcnally

Copy link
Copy Markdown
Contributor

Why

After #100 merged, a reviewer suggested that the table in "Get started with Replica" was more formatting than the content needed. They also suggested a copy-paste prompt so new users can have Copilot guide them through setup (review comment).

What changes

  • The three getting-started paths are now bold links followed by one short sentence, instead of a two-column table.
  • A new "Have Copilot help you get started" section gives a prompt to paste into the GitHub Copilot app. Copilot reads the README, asks which path fits, and walks the user through it.

The link targets and guide descriptions are unchanged.

Replace the getting-started table with bold link headings and add a
copy-paste prompt so Copilot can guide new users through setup.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI auto review requested due to automatic review settings October 29, 2026 13:26
@cmcnally
cmcnally requested review from a team and nshki as code owners October 29, 2026 13:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The documentation-only changes preserve the existing onboarding destinations and no active review issues remain.

No open issues 🎉

What changed in this PR

This documentation-only PR simplifies the Replica getting-started paths in README.md and adds a copy-paste prompt for GitHub Copilot to guide setup.

Changes:

  • Replaces the getting-started table with bold links and concise descriptions.
  • Adds a “Have Copilot help you get started” section with a reusable prompt.
  • Preserves the existing guide destinations and onboarding flow.
  • Review note: the first path’s wording differs from the PR description and includes an additional sentence; preserve the original wording or update the description.
File Summary
README.md Simplifies onboarding paths and adds Copilot-assisted setup guidance.

Review effort: Lite (auto)

@nshki
nshki merged commit c645675 into main Oct 29, 2026
33 checks passed
@nshki
nshki deleted the cmcnally-readme-get-started-links branch October 29, 2026 15:18
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.

3 participants