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

Fixing command formatting under the section "Install using NuGet Package Manager" #966

Closed
wants to merge 1 commit into from

Conversation

ryangurn
Copy link

@ryangurn ryangurn commented Mar 1, 2024

Description Of Changes

Adjusted the formatting of the alternate installation method in the section Install using NuGet Package Manager so the three commands do not all appear (visually) to be one command.

Motivation and Context

When viewing the docs, I read the command in the screenshot below as a single command when it is clearly three. Since reading is hard, I figured making this a list would be more helpful and accessible.

We could also change it to be an ordered list (lets see if there is discussion on that)

Testing

  • I have previewed these changes using the Docker Container or another method before submitting this pull request.

Change Types Made

  • Minor documentation fix (typos etc.).
  • Major documentation change (refactoring, reformatting or adding documentation to existing page).
  • New documentation page added.
  • The change I have made should have a video added, and I have raised an issue for this.
    • Issue #

Change Checklist

  • Requires a change to menu structure (top or left-hand side)/
  • Menu structure has been updated

Related Issue

None

Fixes

None

The formatting for the install steps using `Install-Package` and `Initialize-Chocolatey` were not on separate lines due to markdown formatting. 

The three commands are now in a list.
@pauby
Copy link
Member

pauby commented May 15, 2024

Is there a reason this PR is still in draft?

st3phhays added a commit to st3phhays/docs that referenced this pull request May 17, 2024
In order to install Astro, we need to remove
everything from the folder and basically "start
from scratch". This allowed Astro to create a new
project with the recommended file structure.
st3phhays added a commit to st3phhays/docs that referenced this pull request May 17, 2024
This is the baseline Astro project that was
created by running the recommended commands by
Astro. A few files may have been altered here,
like the .gitignore.
@st3phhays
Copy link
Member

Hey @ryangurn thanks for suggesting this change. I've included this change in my PR and it will go in in the near future.

@st3phhays st3phhays closed this May 21, 2024
@ryangurn
Copy link
Author

Thanks @st3phhays! That formatting fix will at least help me a bunch. 😆

@ryangurn ryangurn deleted the patch-1 branch May 22, 2024 15:42
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.

None yet

3 participants