Skip to content

docs: clarify Replica onboarding paths - #100

Open
cmcnally wants to merge 5 commits into
mainfrom
cmcnally-replica-onboarding
Open

cmcnally wants to merge 5 commits into
mainfrom
cmcnally-replica-onboarding

Conversation

@cmcnally

Copy link
Copy Markdown
Contributor

Why

First-time setup crossed between guides and made hosting requirements easy to discover too late. Readers need a clear path for local prototyping, team hosting, or joining an existing setup, without repeating completed work.

What changes

Add a local prototyping walkthrough and make the hosted walkthrough self-contained. State hosting and network requirements early, explain plugin and canvas setup, and give readers precise continuation points for work they have already completed. Keep the repository setup guide explicitly focused on instructions for Copilot.

Update the README and documentation index to explain the three starting paths. Add the AI product framing, product demo, and collapsible music credits while preserving the README's privacy, support, and license sections.

Public playback of the uploaded demo remains unverified: anonymous requests to its attachment URL returned 404.

Separate local prototyping, shared hosting, and joining an existing team. Clarify prerequisites and continuation steps, and update the README with product framing and a demo.

Co-authored-by: Copilot App <[email protected]>
Copilot-Session: 045ed8e1-41ea-44f3-a2c6-d9f485f87ca1
Copilot AI max review requested due to automatic review settings October 23, 2026 00:26
@cmcnally
cmcnally requested review from a team and nshki as code owners October 23, 2026 00:26

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

Documented onboarding paths can still leave users blocked before setup or first publication completes.

3 open issues
What changed in this PR

Clarifies Replica onboarding by separating local prototyping, shared hosting, and joining an existing team environment.

Changes:

  • Adds a local walkthrough covering repository setup, canvas activation, team guidance, and a first prototype.
  • Expands hosted setup with early infrastructure checks and continuation points that reuse completed work.
  • Updates README framing, demo content, and navigation while keeping repository setup instructions focused on Copilot.
File Description
README.md Updates product framing, demo content, and the three onboarding paths.
hub/​docs/​deployment.md Adds outbound network requirements for deployment and Hub.
docs/​README.md Distinguishes user walkthroughs from the supporting agent guide.
docs/​prototype-repository-setup.md Clarifies Copilot’s repository setup, approvals, and session handoff.
docs/​prototype-environment.md Expands shared hosting setup from readiness checks through team feedback.
docs/​local-prototyping.md Adds the local-first prototyping walkthrough and sharing continuations.
docs/​getting-started.md Focuses onboarding on joining an existing team environment.

Review effort: Max

Comment thread docs/prototype-environment.md Outdated
Comment thread docs/prototype-repository-setup.md
Comment thread hub/docs/deployment.md Outdated
cmcnally and others added 4 commits October 22, 2026 21:54
Added instructions for checking workflow presence and handling merges.

Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Updated the running Hub container section to include GitHub sign-in requirements and clarified the connection process for the GitHub App.

Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Resolve conflict in hub/docs/deployment.md by keeping both the new
outbound network access section and the new server-side tracing section.

Co-authored-by: Copilot App <[email protected]>
Copilot-Session: 424c906c-5e6b-4d71-ba71-edd25c7c1191
Reformatted instructions for clarity and readability.

@yaili yaili left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you, @cmcnally.

Generally it feels easier to follow, but I think we need a review focused on the following:

  • Introduce formatting that makes sense for the text (e.g. I made a direct edit in the first section where it made sense to have list items)
  • Separate more clearly what is a step and what is commentary.
  • Break up long paragraphs that should be lists or some other format.

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