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

Additional Documentation #1645

Merged
merged 9 commits into from
Jun 18, 2024
Merged

Additional Documentation #1645

merged 9 commits into from
Jun 18, 2024

Conversation

Pickysaurus
Copy link
Contributor

Created a new "Adding Games" page to user docs.
Improved the "Getting Started" page by adding buttons to the Windows/Linux download options and mentioning the Linux packages.
Corrects several small mistakes in existing docs.

@Pickysaurus Pickysaurus added the Documentation This is related to our documentation. label Jun 18, 2024
@Pickysaurus Pickysaurus requested a review from Al12rs June 18, 2024 15:19
docs/users/SystemRequirements.md Outdated Show resolved Hide resolved
docs/users/images/OAuthSignIn.png Outdated Show resolved Hide resolved
docs/users/GettingStarted.md Show resolved Hide resolved
docs/users/GettingStarted.md Outdated Show resolved Hide resolved
@erri120
Copy link
Member

erri120 commented Jun 18, 2024

Images should also be WebP, binary blobs can make git checkout very slow over time. Make sure to use a rebase for this, so that the original PNGs aren't in the history. We'll squash merge.

@Pickysaurus
Copy link
Contributor Author

Images should also be WebP, binary blobs can make git checkout very slow over time. Make sure to use a rebase for this, so that the original PNGs aren't in the history.

There is not a good way to create WebPs on Windows. I can compress them as JPGs or we can split the docs off into a submodule?

@erri120
Copy link
Member

erri120 commented Jun 18, 2024

Images should also be WebP, binary blobs can make git checkout very slow over time. Make sure to use a rebase for this, so that the original PNGs aren't in the history.

There is not a good way to create WebPs on Windows. I can compress them as JPGs or we can split the docs off into a submodule?

I'll turn them into WebPs. Most editing software should be able to do this tho (Paint.NET, GIMP, Photoshop).

@halgari halgari dismissed erri120’s stale review June 18, 2024 21:46

Requested changes were handled

@halgari halgari merged commit d1a5755 into main Jun 18, 2024
3 checks passed
@halgari halgari deleted the user-docs2 branch June 18, 2024 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation This is related to our documentation.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants