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

[Feature] Update the documentation #5581

Closed
walpox opened this issue Jul 16, 2023 · 4 comments
Closed

[Feature] Update the documentation #5581

walpox opened this issue Jul 16, 2023 · 4 comments

Comments

@walpox
Copy link
Contributor

walpox commented Jul 16, 2023

Feature Request

I am not sure whether updating the documentation is a feature request, a bug fix, a mix of both, or something else, so apologies in advance if the category of this issue is incorrect.

I have reviewed the README.md file and made some changes such as:

  • General changes to style to make the text more formal and concise.
  • Fixed any typos I have encountered.
  • Refactored the code blocks.
  • Changed the links in the Inspiration section to those projects' homepages (as defined in their git repositories).
  • Replaced the reference to the Scoop Directory service. It now points to ScoopSearch because the Scoop Directory page states it is deprecated.
  • Refactored the HTML blocks and attempted to replace the deprecated 'align' attribute. However, it seems GitHub does not work well when centering HTML elements using the 'style' attribute instead.

Those changes are available on my fork here:
master...walpox:Scoop:documentation

After your review, it can be decided whether or not to create the corresponding pull request.

Note:
In the PowerShell code block to install Scoop, I am not sure if the two comment lines should reside there or outside, would appreciate your feedback. Copy-pasting does not seem to be an issue, as the comments are ignored by the PowerShell terminal.

@walpox
Copy link
Contributor Author

walpox commented Jul 16, 2023

I have also added explicitly the HTTPS protocol in the "Invoke-RestMethod" cmdlet for security reasons. Otherwise, it uses HTTP implicitly to download the Scoop installation script.

@rashil2000
Copy link
Member

Hi, could you please raise a PR? (targeting the develop branch)

@walpox walpox mentioned this issue Sep 10, 2023
5 tasks
@walpox
Copy link
Contributor Author

walpox commented Sep 10, 2023

Hi, could you please raise a PR? (targeting the develop branch)

Consider it done: #5638.

@rashil2000
Copy link
Member

Merged in #5638

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

No branches or pull requests

2 participants