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

Jump to bottom

Docs: README suggestions #1

Open

marissahuysentruyt opened this issue Oct 17, 2023 · 0 comments

marissahuysentruyt commented Oct 17, 2023 •

edited

Loading

The doc site's README has some potential for clarification and rework.

What about rephrasing the first sentence?

FROM:

This repository is for the Propulsion Design System Tool documentation site.

TO:

This repository is the documentation site for Propulsion Design System Builder.

add a comma in "Getting Started" step 2

FROM:

From a command prompt open the repo directory

TO:

From a command prompt, open the repo directory

remove the period in "Getting Started step 4 to be consistent with other steps that have no period
add a link to the Propulsion issues page in the last line

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment