Skip to content
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.

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

Docs: Getting Started suggestions #10

Open
marissahuysentruyt opened this issue Oct 17, 2023 · 0 comments
Open

Docs: Getting Started suggestions #10

marissahuysentruyt opened this issue Oct 17, 2023 · 0 comments

Comments

@marissahuysentruyt
Copy link

More content suggestions that might help clarify

  • Should we put the Github button text ("Use this template" and "Code") is quotes at all? I didn't realize it was even bolded at first, so I missed that we were talking about the buttons on Github.
  • Break up the first sentence a bit:

FROM:

To get started with Propulsion, first head over to the GitHub repo and select the Use this template button to quickly create your own copy of the repo, otherwise, download the project as a ZIP package under the Code dropdown.

TO:

To get started with Propulsion, first head over to the GitHub repo. Select the "Use this template" button to quickly create your own copy of the repo, or download the project as a ZIP package under the "Code" dropdown.

  • Reword the sentence on "System Requirements" (not sure if this change really is any better)

FROM:

Propulsion requires Node.js to be installed in order to run.

TO:

In order to run, Propulsion requires Node.js to be installed.

  • Change the beginning of this sentence to match the other description of the start command.

FROM:

The installation will download and install...

TO:

This command will download and install...

  • Once more, match the cadence of the prior descriptions, using "command prompt"

FROM:

...run the following command:

TO:

...run the following command in a command prompt:

  • I wasn't sure if the last sentence should be singular "build" or plural "builds." If it's singular, maybe we just need "test the design system build?" 🤷‍♀️
    "Open that URL in a browser to review and test design system build."
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

No branches or pull requests

1 participant