Skip to content

Update docs with supported versions of Windows, macOS, and Linux (#2258) #2276

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

Merged
merged 1 commit into from
Feb 13, 2023

Conversation

kcgen
Copy link
Member

@kcgen kcgen commented Feb 11, 2023

This PR is a replacement for #2272 with the only change being that its commits have been squashed into a single commit.

Fixes #2258.

@kcgen kcgen added the documentation Improvements or additions to documentation label Feb 11, 2023
@kcgen kcgen requested a review from johnnovak February 11, 2023 16:25
@kcgen
Copy link
Member Author

kcgen commented Feb 11, 2023

@Torinde , I'm just skimming through the changes you made here, and wow: so many fixes and clarifications, plus the addition of the 32bit build w/ hash. This is great!

@kcgen
Copy link
Member Author

kcgen commented Feb 11, 2023

@Torinde, if you check your email, you've been added to the DOSBox Staging team (I think you have to accept it).

Welcome! You have write access now, which means you can administer tickets, projects, and PR attributes (labels, assignments, close/open, etc).

More importantly, you can now create your own branches directly inside the repository (instead of needing to fork the repo).

We create our branches named like this: "initials/branch-name-revision"

You can see here, I named this branch torinde/docs-os-support-1 (as I don't know your initials). When the branch passes review, maintainers will merge its commits into main followed by deleting the branch.

We have some notes here on how we work with PRs and branches. Although these mention "code", feel free to mentally substitute that with "documentation", as both go through the same process (even compilation in a sense.. MkDocs renders the markdown to HTML, with the website being the interactive result).

https://github.com/dosbox-staging/dosbox-staging/wiki/Maintenance-and-Release-Notes#3-contributing-and-reviewing-prs

Also, @FeralChild64 and @johnnovak both offered very helpful comments to another recent contributor here (which I highly recommend):

#2248 (comment)

@kcgen kcgen force-pushed the torinde/docs-os-support-1 branch from dc6a6eb to 94d3cf2 Compare February 11, 2023 17:59
@johnnovak johnnovak force-pushed the torinde/docs-os-support-1 branch from 94d3cf2 to 0ed1d22 Compare February 13, 2023 00:33
Copy link
Member

@johnnovak johnnovak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job @Torinde, merging finally! 🎉

I finally created the first version of our documentation guidelines. It also contains information on setting up MkDocs locally so you can preview your changes in the future. Check it out here:

https://github.com/dosbox-staging/dosbox-staging/blob/main/DOCUMENTATION.md

@johnnovak johnnovak merged commit c785afc into main Feb 13, 2023
@delete-merged-branch delete-merged-branch bot deleted the torinde/docs-os-support-1 branch February 13, 2023 03:03
@Torinde Torinde self-assigned this Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Vista, Mac OS X 10.5 - which are the earliest versions still supported as host for running Staging?
3 participants