Skip to content

docs: simplify README getting-started paths #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nshki merged 1 commit into from
Oct 29, 2026
+13 −5
Merged

docs: simplify README getting-started paths #152

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,22 @@ https://github.com/user-attachments/assets/36547180-aca9-43cc-8931-b538f0883885

You don't need to set up everything at once. Start with the guide that matches your next step: trying Replica locally, setting up hosting, or joining your team's existing repository and Hub.

| Your goal | Start here |
| --- | --- |
| Start or continue prototyping locally | [Create your first local prototype](docs/local-prototyping.md). Use the starter or an existing prototype repository, add team guidance, and build something useful. No Hub required. |
| Set up hosting and comments for your team | [Set up shared hosting and team feedback](docs/prototype-environment.md). Check hosting needs early, build with your team's design guidance, and connect Hub when it is ready. |
| Join a team with a repository and Hub already in use | [Join your team's Replica environment](docs/getting-started.md). Use its existing setup to create, publish, and review a prototype. |
**[Create your first local prototype](docs/local-prototyping.md).** Use the starter or an existing prototype repository, add team guidance, and build something useful. No Hub required, so it's a quick way to try Replica out.

**[Set up shared hosting and team feedback](docs/prototype-environment.md).** Check hosting needs early, build with your team's design guidance, and connect Hub when it is ready.

**[Join your team's Replica environment](docs/getting-started.md).** Use its existing setup to create, publish, and review a prototype.

If hosting is blocked, you can work locally and connect the same repository later.

### Have Copilot help you get started

Paste this prompt into the GitHub Copilot app, and Copilot will guide you:

```text
Read the Replica README at https://github.com/github/replica. Ask which getting-started path fits my needs, then guide me through it step by step.
```

### What you need

**Local prototyping** uses the [GitHub Copilot app](https://github.com/features/ai/github-app), Git, and Node.js with npm on macOS or Linux. Each walkthrough covers installation and the repository's requirements.
Expand Down
Loading