Skip to content

[WIP] Documentation update for 3.8.1#7798

Merged
harry-cpp merged 8 commits intoMonoGame:developfrom
FlyingOakGames:docs
Jun 30, 2022
Merged

[WIP] Documentation update for 3.8.1#7798
harry-cpp merged 8 commits intoMonoGame:developfrom
FlyingOakGames:docs

Conversation

@ThomasFOG
Copy link
Copy Markdown
Contributor

@ThomasFOG ThomasFOG commented May 12, 2022

This is a work in progress.

Here is a documentation update for the upcoming 3.8.1 release.

I am trying to simplify it where possible, and to make it more readable/straightforward.
So far I have mostly worked on the getting started/onboarding, but I intend to go through all of it to harmonize things up.

Fixes #7662

@ThomasFOG ThomasFOG added this to the 3.8.1 milestone May 12, 2022
@ThomasFOG ThomasFOG marked this pull request as draft May 12, 2022 21:12
@ThomasFOG
Copy link
Copy Markdown
Contributor Author

ThomasFOG commented May 22, 2022

This is pretty much "3.8.1 ready" and only needs the VS2022 Mac extension to be uploaded somewhere in order to be able to point to it.

I believe that it is as good as it can get if we want to promptly release 3.8.1. Better documentation will require more thorough planning (I'll open an issue to plan that later).

@ThomasFOG ThomasFOG mentioned this pull request May 22, 2022
36 tasks
@CartBlanche
Copy link
Copy Markdown
Contributor

CartBlanche commented Jun 13, 2022

@mrhelmut I didn't realise you had a PR outstanding and pushed a small grammatical fix to https://github.com/MonoGame/MonoGame/blob/develop/MonoGame.Framework/GameRunBehavior.cs after it was brought to my attention on Twitter. You may want to pull in the latest from develop to pick it up.

@ThomasFOG
Copy link
Copy Markdown
Contributor Author

Thanks for letting me know! I will!

@ThomasFOG ThomasFOG marked this pull request as ready for review June 28, 2022 21:17
@ThomasFOG
Copy link
Copy Markdown
Contributor Author

@harry-cpp I've updated this PR to preemptively link toward the mac extension (by linking to the release assets instead of the mpack direct link). This would allow us to merge this PR and then #7823 to make the release and move forward.

In addition to the deploy task, what do you think if I do a release task that creates the github release with the VS extensions as assets to the release and the description pointing toward the packages?

@ThomasFOG ThomasFOG mentioned this pull request Jun 28, 2022
@harry-cpp harry-cpp merged commit 9535773 into MonoGame:develop Jun 30, 2022
@ThomasFOG ThomasFOG deleted the docs branch June 30, 2022 07:28
bytinggames pushed a commit to bytinggames/MonoGame that referenced this pull request Oct 9, 2022
* Started to rework documentation

* Documentation update

* More documentation updates

* Minor formatting and language use updates

* Additional updates

* Fix mac extension link

* Added action badge to build status

Co-authored-by: Simon Jackson <darkside@zenithmoon.com>
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.

Dead link to "SpaceWar" in Samples & Demos documentation

4 participants