Skip to content

Commit a6f3b21

Browse files
tomspilmantomspilman
authored
Merge branch 'main' into feature/showcase-filters
2 parents 0221b10 + c507816 commit a6f3b21

File tree

4 files changed

+136
-54
lines changed

4 files changed

+136
-54
lines changed

‎CONTRIBUTING.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
THIS IS A WORK IN PROGRESS!
2+
3+
# MonoGame Documentation
4+
5+
This is the source for the [documentation published on MonoGame.net](http://www.monogame.net/documentation/). It is rebuilt when the code changes and is published nightly to the website.
6+
7+
## General Rules
8+
9+
The following rules must be observed at all times when contributing documentation to the MonoGame project.
10+
11+
- Write in a neutral, technical tone.
12+
- Avoid humor, personal opinions, and colloquial language.
13+
- **Never** plagiarize any documentation from another source.
14+
- Do not use automatic documentation tools as they are ineffective.
15+
16+
Breaking these rules can result in your contribution being rejected.
17+
18+
## Getting Started
19+
20+
You can create and edit documentation right from the web browser without needing to install Git or ever leave the GitHub site.
21+
22+
- [Fork the MonoGame repo](https://help.github.com/articles/fork-a-repo/).
23+
- [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) from `develop` and make your changes only in that branch.
24+
- [Create a new file](https://help.github.com/articles/creating-new-files/) or [edit an existing one](https://help.github.com/articles/editing-files-in-your-repository/) using the GitHub markup editor.
25+
- [Submit pull requests](https://help.github.com/articles/creating-a-pull-request/) early and often to merge your documentation changes.
26+
27+
## Style Guide
28+
29+
Review the following expectations before contributing any documentation.
30+
31+
### Manuals, Guides, and Tutorials
32+
33+
TODO!
34+
35+
### API Reference
36+
37+
The API reference documentation is a big part of the documentation effort for MonoGame. The documentation is written in the [C# XML format](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments) and is inline to the MonoGame source code. The final web pages with API documentation are generated using [DocFX]([DocFX - static documentation generator | DocFX website](https://dotnet.github.io/docfx/)).
38+
39+
#### Every Word Should Contain Value
40+
41+
Every word in the reference documentation should provide information beyond the API itself. Documentation that only rehashes or rephrases what is already apparent in the class, method, parameter, or property name has zero value and wastes time for both the writer and reader.
42+
43+
#### The First Sentence Is the Most Important
44+
45+
There is no guarantee that the reader will read beyond the first sentence of the reference documentation. This is why that first sentence is the most important and should convey the most key piece of information. Take your time to write the most concise and clear first sentence possible. This helps users tremendously and goes a long way towards having great documentation.
46+
47+
#### Surface Information Hidden in the Code
48+
49+
Being inline with the code allows you to easily look for critical information within it that the user might not know from looking at the API alone. Take your time to explore inner method calls and platform specific sections of the code. The time to write the documentation is once you feel you fully understand the code you are documenting. If you don't feel you understand the code then leave the documentation for someone else to write.
50+
51+
#### Documentation Is Referenced Not Read
52+
53+
Remember that the user is searching for an answer for a specific question. It is your job to predict these questions and provide them clear answers.
54+
55+
## License
56+
57+
All documentation contributed to the MonoGame project is subject to the [Creative Commons Attribution-NonCommercial-ShareAlike](http://creativecommons.org/licenses/by-nc-sa/4.0/) license. By contributing you are agreeing to the terms of that license.
58+
59+
<p align="center"><a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/Text" property="dct:title" rel="dct:type">MonoGame Documentation</span> by the <a xmlns:cc="http://creativecommons.org/ns#" href="http://www.monogame.net" property="cc:attributionName" rel="cc:attributionURL">MonoGame Team</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike License</a>.</p>

‎LICENSE

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
Microsoft Public License (Ms-PL)
2+
MonoGame - Copyright © 2009-2023 The MonoGame Team
3+
4+
All rights reserved.
5+
6+
This license governs use of the accompanying software. If you use the software,
7+
you accept this license. If you do not accept the license, do not use the
8+
software.
9+
10+
1. Definitions
11+
12+
The terms "reproduce," "reproduction," "derivative works," and "distribution"
13+
have the same meaning here as under U.S. copyright law.
14+
15+
A "contribution" is the original software, or any additions or changes to the
16+
software.
17+
18+
A "contributor" is any person that distributes its contribution under this
19+
license.
20+
21+
"Licensed patents" are a contributor's patent claims that read directly on its
22+
contribution.
23+
24+
2. Grant of Rights
25+
26+
(A) Copyright Grant- Subject to the terms of this license, including the
27+
license conditions and limitations in section 3, each contributor grants you a
28+
non-exclusive, worldwide, royalty-free copyright license to reproduce its
29+
contribution, prepare derivative works of its contribution, and distribute its
30+
contribution or any derivative works that you create.
31+
32+
(B) Patent Grant- Subject to the terms of this license, including the license
33+
conditions and limitations in section 3, each contributor grants you a
34+
non-exclusive, worldwide, royalty-free license under its licensed patents to
35+
make, have made, use, sell, offer for sale, import, and/or otherwise dispose of
36+
its contribution in the software or derivative works of the contribution in the
37+
software.
38+
39+
3. Conditions and Limitations
40+
41+
(A) No Trademark License- This license does not grant you rights to use any
42+
contributors' name, logo, or trademarks.
43+
44+
(B) If you bring a patent claim against any contributor over patents that you
45+
claim are infringed by the software, your patent license from such contributor
46+
to the software ends automatically.
47+
48+
(C) If you distribute any portion of the software, you must retain all
49+
copyright, patent, trademark, and attribution notices that are present in the
50+
software.
51+
52+
(D) If you distribute any portion of the software in source code form, you may
53+
do so only under this license by including a complete copy of this license with
54+
your distribution. If you distribute any portion of the software in compiled or
55+
object code form, you may only do so under a license that complies with this
56+
license.
57+
58+
(E) The software is licensed "as-is." You bear the risk of using it. The
59+
contributors give no express warranties, guarantees or conditions. You may have
60+
additional consumer rights under your local laws which this license cannot
61+
change. To the extent permitted under your local laws, the contributors exclude
62+
the implied warranties of merchantability, fitness for a particular purpose and
63+
non-infringement.

‎README.md

+13-53
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,19 @@
1-
THIS IS A WORK IN PROGRESS!
1+
# monogame.github.io
22

3-
# MonoGame Documentation
3+
This repository contains the documenation and the website for MonoGame.
44

5-
This is the source for the [documentation published on MonoGame.net](http://www.monogame.net/documentation/). It is rebuilt when the code changes and is published nightly to the website.
5+
## Building from source
66

7-
## General Rules
7+
First up restore the dotnet tooling, this restores the `docfx` cli tool needed to build the website.
8+
```sh
9+
dotnet tool restore
10+
```
811

9-
The following rules must be observed at all times when contributing documentation to the MonoGame project.
12+
Next to build the website, simply invoke the restored docfx tool from the CLI:
13+
```
14+
dotnet docfx docfx.json --serve
15+
```
1016

11-
- Write in a neutral, technical tone.
12-
- Avoid humor, personal opinions, and colloquial language.
13-
- **Never** plagiarize any documentation from another source.
14-
- Do not use automatic documentation tools as they are ineffective.
17+
## LICENSE
1518

16-
Breaking these rules can result in your contribution being rejected.
17-
18-
## Getting Started
19-
20-
You can create and edit documentation right from the web browser without needing to install Git or ever leave the GitHub site.
21-
22-
- [Fork the MonoGame repo](https://help.github.com/articles/fork-a-repo/).
23-
- [Create a new branch](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/) from `develop` and make your changes only in that branch.
24-
- [Create a new file](https://help.github.com/articles/creating-new-files/) or [edit an existing one](https://help.github.com/articles/editing-files-in-your-repository/) using the GitHub markup editor.
25-
- [Submit pull requests](https://help.github.com/articles/creating-a-pull-request/) early and often to merge your documentation changes.
26-
27-
## Style Guide
28-
29-
Review the following expectations before contributing any documentation.
30-
31-
### Manuals, Guides, and Tutorials
32-
33-
TODO!
34-
35-
### API Reference
36-
37-
The API reference documentation is a big part of the documentation effort for MonoGame. The documentation is written in the [C# XML format](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments) and is inline to the MonoGame source code. The final web pages with API documentation are generated using [DocFX]([DocFX - static documentation generator | DocFX website](https://dotnet.github.io/docfx/)).
38-
39-
#### Every Word Should Contain Value
40-
41-
Every word in the reference documentation should provide information beyond the API itself. Documentation that only rehashes or rephrases what is already apparent in the class, method, parameter, or property name has zero value and wastes time for both the writer and reader.
42-
43-
#### The First Sentence Is the Most Important
44-
45-
There is no guarantee that the reader will read beyond the first sentence of the reference documentation. This is why that first sentence is the most important and should convey the most key piece of information. Take your time to write the most concise and clear first sentence possible. This helps users tremendously and goes a long way towards having great documentation.
46-
47-
#### Surface Information Hidden in the Code
48-
49-
Being inline with the code allows you to easily look for critical information within it that the user might not know from looking at the API alone. Take your time to explore inner method calls and platform specific sections of the code. The time to write the documentation is once you feel you fully understand the code you are documenting. If you don't feel you understand the code then leave the documentation for someone else to write.
50-
51-
#### Documentation Is Referenced Not Read
52-
53-
Remember that the user is searching for an answer for a specific question. It is your job to predict these questions and provide them clear answers.
54-
55-
## License
56-
57-
All documentation contributed to the MonoGame project is subject to the [Creative Commons Attribution-NonCommercial-ShareAlike](http://creativecommons.org/licenses/by-nc-sa/4.0/) license. By contributing you are agreeing to the terms of that license.
58-
59-
<p align="center"><a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/Text" property="dct:title" rel="dct:type">MonoGame Documentation</span> by the <a xmlns:cc="http://creativecommons.org/ns#" href="http://www.monogame.net" property="cc:attributionName" rel="cc:attributionURL">MonoGame Team</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike License</a>.</p>
19+
The MonoGame project is under the Microsoft Public License except for a few portions of the code. See the [LICENSE](LICENSE) file for more details.

‎articles/whats_new.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ We now support [.NET 6](https://docs.microsoft.com/en-us/dotnet/core/introductio
1818

1919
MonoGame 3.8.1 now comes with an optional Visual Studio extension which will install all the MonoGame project templates and will allow for quick access to the [MGCB Editor](./tools/mgcb_editor.md).
2020

21-
This extension is avaible for Visual Studio 2022, and Visual Studio 2022 for Mac.
21+
This extension is available for Visual Studio 2022, and Visual Studio 2022 for Mac.
2222

2323
## Visual Studio 2019 and prior are no longer supported
2424

0 commit comments

Comments
 (0)