MonoGame/MonoGame

Call to improve the documentation using XNA documentation

Offen

#7.808 geöffnet am 21.05.2022

 (13 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)C# (3.071 Forks)batch import
docsgood first issuescope: docs

Repository-Metriken

Stars
 (13.886 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 25T 3h) (22 gemergte PRs in 30 T)

Beschreibung

Even though MonoGame is a verbatim re-implementation of Microsoft's XNA 4, we were not allowed to reproduce XNA's API documentation.

We now have the authorization from Microsoft to use the former official XNA documentation for use in MonoGame's documentation, including the API documentation and blog articles, as long as we mention © 2012 Microsoft Corporation. All rights reserved. wherever we use any of it (#7798 is already taking care of the legal mention, so contributions to the documentation shouldn't have to bother about this).

This is an opportunity to refresh the API documentation of MonoGame, as well as writing more in-depth documentation articles.

Any kind of help in that regard is more that welcome and is likely a very good way to contribute for the first time.

The documentation articles source can be found here and are written in markdown format. The API documentation source is within the API itself, and generated from the actual C# source code using XML documentation.

Contributor Guide