Skip to content

docs: add Arcade installation walkthrough video to getting started guide#572

Open
AbhishekDoshi26 wants to merge 10 commits into
mainfrom
feat/arcades
Open

docs: add Arcade installation walkthrough video to getting started guide#572
AbhishekDoshi26 wants to merge 10 commits into
mainfrom
feat/arcades

Conversation

@AbhishekDoshi26

@AbhishekDoshi26 AbhishekDoshi26 commented Jun 29, 2026

Copy link
Copy Markdown
Member

Status

READY

Description

This PR embeds the 2-minute Arcade walkthrough video into getting-started/index.mdx and code-push/index.mdx

https://app.arcade.software/share/FP0avaIIQ1MtBzMaQpkT

https://app.arcade.software/share/eTUuhVp2OJkmg4vRGnRD

@AbhishekDoshi26 AbhishekDoshi26 requested a review from tomarra June 29, 2026 12:40
@tomarra

tomarra commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Acrade notes

  • Create your free Shorebird account to get started (remove the "instant access to all features")
  • For the login step I would remove SSO as its not going to be applicable to most people
  • On the guides section you have the 1Password popup showing which should be removed
  • Feels like logging in and then pointing them back to the docs is recursive. Like I'm almost going backwards.
  • Paste the command in your terminal to get the Shorebird CLI installed (missing the CLI word)
  • The "Stay focused on the terminal" and "watch as shorbird..." items can be dropped, fluff. Go right to the end of the install.
  • We should consider using a demo account instead of your email address in there so we have a demo one to use going forward as well. Just making a new gmail if we dont have one of like "shorebird_demo@gmail.com"
  • In the future it would be good to use a clean install of chrome or some other browser that then seeing all your extensions and profile.
  • Same thing for the Menu bar. There are apps out there that will clean that up and make it so nothing is there in order to keep peoples focus on the content.

@tomarra

tomarra commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

I've updated the branch to include the "ArcadeEmbed" component, lets use that as well.

@dawn-ducky

Copy link
Copy Markdown
Contributor
  • We should consider using a demo account instead of your email address in there so we have a demo one to use going forward as well. Just making a new gmail if we dont have one of like "shorebird_demo@gmail.com"

We have the ability to obfuscate emails and personal information in Arcade. We do likely need a demo account though for when we want to do live demos so we're not logging into our personal accounts. Even using a demo account that should be obfuscated.

@dawn-ducky

Copy link
Copy Markdown
Contributor

Arcade updates:

Headers need to be all upper case or sentence case not camel case.
Remove exclamation points.

Title slide change sub-title to " How to configure Shorebird." No exclamation points. Also anytime we are writing for a user it should be "you" not "we."

Obfuscate names and personal information in the terminal windows

Comment thread src/content/docs/getting-started/index.mdx Outdated
@tomarra

tomarra commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Getting Started Arcade

  • The "seamless Shorebird onboarding experience" is a lot of fluff words that are not needed
  • The login buttons one is the same, a lot of extra words. Something more like "Create your Shorebird account by using your existing Google or Microsoft based account"
  • I don't think we need to show the actual Google or Microsoft login flow thats pretty standard. - The flash of the console after logging in and then jumping back to docs feels weird. We can update the "Get Started" card in the console to point to the quick start guide and then you would be at the page you need to get the install script and its better then saying "go back to docs"
  • Nit - It takes a lot of seconds to install the CLI so I wouldn't talk about that. Just say that it's one simple command to get installed.
  • The Shorebird Doctor section starts with you typing in the terminal below the screen and its cut off.
  • The "no issues detected" is not lined up with the text on screen. I assume this is because its low in the window and you should just move that up in the screenshot
  • There's no real call to action at the end, your just left with the CLI installed. Should we have an ending that points them back to docs to get their first build up and running or the next arcade demo?

New Flutter Project Arcade

  • Shorebird isn't capitalized on the subtitle of the landing screen
  • I wouldn't use the word "shorebird" in the app name as that starts to get confusing with the overall "shorebird" cli directive on the line as well. Even just weather_demo would be fine.
  • Ensure that Shorebird is always capitalized as its our brand name. Found it again on the "How should we refer to this app" call out.
  • Again no real call to action for next steps and there doesn't seem to be anything that tells me why I would use this over flutter create. Even just mentioning at the top "to create your app and automatically register it with Shorebird" would be good enough.

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