{"action":"created","comment":{"url":"https://api.github.com/repos/mono/MonoGame/pulls/comments/48882068","id":48882068,"diff_hunk":"@@ -39,4 +39,32 @@ If you need to make changes to the pull request, simply repeat steps 2-4.  Addin\n \n The majority of code in MonoGame is cross-platform and must build and behave correctly on all supported platforms.  All pull requests to MonoGame are built using an automated system that compiles the pull request on all supported platforms and will report any build errors.\n \n-Once a pull request has been accepted, your feature branch can be deleted if desired.\n\\ No newline at end of file\n+Once a pull request has been accepted, your feature branch can be deleted if desired.\n+\n+Generating Documentation\n+========================\n+Monogame generates its documentation using the [SharpDoc library] (https://github.com/xoofx/SharpDoc)\n+\n+You can view the documentation for your changes both locally, and (after you have submitted a PR) on the build server.\n+\n+### Local documentation generation\n+Local documentation generation is not automatic. You have to run the SharpDoc tool to generate it for you.\n+The commandline for doing this is: `ThirdParty\\Dependencies\\SharpDoc\\SharpDoc.exe -config <config file> -output <output directory>`\n+e.g. `ThirdParty\\Dependencies\\SharpDoc\\SharpDoc.exe -config Documentation\\config.xml -output GeneratedDocs`\n+Run this command from the root folder of your local MonoGame repository clone. It will generate all the documentation under `Documentation\\<output directory>` folder. You can go ahead and start browsing from the `index.html` file.\n+\n+**Gotchas:**\n+- This assumes that all platforms (Windows, Linux, Mac, etc.) have been built. If you can't (or don't want to) build for all of the platforms, you can comment out the relevant sections in `Documentation\\config.xml`.\n+- By default, SharpDoc looks for the build artifacts in the Release folder. Remember to build for Release.\n+- Browsing local documentation seems to work best with Internet Explorer. When you open up `index.html`, you might be prompted to give permission to an ActiveX control. Click \"Allow\", and you will be able to browse through the docs.\n+\n+### Documentation Generation On The Build Server\n+When you submit a PR, the documentation for that PR gets generated, along with all the other build artifacts, on the build server.\n+You can browse this generated documentation.\n+The link for this will be: `http://teamcity.monogame.net/repository/download/MonoGame_DevelopWin/<YOUR_BUILD_ID>:id*/Documentation.zip%21/index.html?guest=1`.\n+You can figure out your build id by inspecting the link that mgbot gives you after a successful build.\n+![Example build success image](/Documentation/images/Example_Build_Success.png)","path":"CONTRIBUTING.md","position":30,"original_position":30,"commit_id":"f40ca4383f29338d0e7adb5f5903d4f8d06e84b9","original_commit_id":"f40ca4383f29338d0e7adb5f5903d4f8d06e84b9","user":{"login":"tomspilman","id":103522,"avatar_url":"https://avatars.githubusercontent.com/u/103522?v=3","gravatar_id":"","url":"https://api.github.com/users/tomspilman","html_url":"https://github.com/tomspilman","followers_url":"https://api.github.com/users/tomspilman/followers","following_url":"https://api.github.com/users/tomspilman/following{/other_user}","gists_url":"https://api.github.com/users/tomspilman/gists{/gist_id}","starred_url":"https://api.github.com/users/tomspilman/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tomspilman/subscriptions","organizations_url":"https://api.github.com/users/tomspilman/orgs","repos_url":"https://api.github.com/users/tomspilman/repos","events_url":"https://api.github.com/users/tomspilman/events{/privacy}","received_events_url":"https://api.github.com/users/tomspilman/received_events","type":"User","site_admin":false},"body":"I'd prefer if we don't embed an image here.  There must be a better way to explain this that doesn't require an image.","created_at":"2016-01-05T19:02:37Z","updated_at":"2016-01-05T19:02:37Z","html_url":"https://github.com/mono/MonoGame/pull/4390#discussion_r48882068","pull_request_url":"https://api.github.com/repos/mono/MonoGame/pulls/4390","_links":{"self":{"href":"https://api.github.com/repos/mono/MonoGame/pulls/comments/48882068"},"html":{"href":"https://github.com/mono/MonoGame/pull/4390#discussion_r48882068"},"pull_request":{"href":"https://api.github.com/repos/mono/MonoGame/pulls/4390"}}},"pull_request":{"url":"https://api.github.com/repos/mono/MonoGame/pulls/4390","id":55114910,"html_url":"https://github.com/mono/MonoGame/pull/4390","diff_url":"https://github.com/mono/MonoGame/pull/4390.diff","patch_url":"https://github.com/mono/MonoGame/pull/4390.patch","issue_url":"https://api.github.com/repos/mono/MonoGame/issues/4390","number":4390,"state":"open","locked":false,"title":"Adding documentation generation info","user":{"login":"hede","id":512790,"avatar_url":"https://avatars.githubusercontent.com/u/512790?v=3","gravatar_id":"","url":"https://api.github.com/users/hede","html_url":"https://github.com/hede","followers_url":"https://api.github.com/users/hede/followers","following_url":"https://api.github.com/users/hede/following{/other_user}","gists_url":"https://api.github.com/users/hede/gists{/gist_id}","starred_url":"https://api.github.com/users/hede/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hede/subscriptions","organizations_url":"https://api.github.com/users/hede/orgs","repos_url":"https://api.github.com/users/hede/repos","events_url":"https://api.github.com/users/hede/events{/privacy}","received_events_url":"https://api.github.com/users/hede/received_events","type":"User","site_admin":false},"body":"Adds information about how to build/browse the documentation after changes have been made\r\nAs requested in #4388 (I hope).","created_at":"2016-01-05T16:56:53Z","updated_at":"2016-01-05T19:02:37Z","closed_at":null,"merged_at":null,"merge_commit_sha":"1ff20806c10e148863566a0fd983baa743b773e3","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/mono/MonoGame/pulls/4390/commits","review_comments_url":"https://api.github.com/repos/mono/MonoGame/pulls/4390/comments","review_comment_url":"https://api.github.com/repos/mono/MonoGame/pulls/comments{/number}","comments_url":"https://api.github.com/repos/mono/MonoGame/issues/4390/comments","statuses_url":"https://api.github.com/repos/mono/MonoGame/statuses/f40ca4383f29338d0e7adb5f5903d4f8d06e84b9","head":{"label":"hede:contributing_docgen","ref":"contributing_docgen","sha":"f40ca4383f29338d0e7adb5f5903d4f8d06e84b9","user":{"login":"hede","id":512790,"avatar_url":"https://avatars.githubusercontent.com/u/512790?v=3","gravatar_id":"","url":"https://api.github.com/users/hede","html_url":"https://github.com/hede","followers_url":"https://api.github.com/users/hede/followers","following_url":"https://api.github.com/users/hede/following{/other_user}","gists_url":"https://api.github.com/users/hede/gists{/gist_id}","starred_url":"https://api.github.com/users/hede/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hede/subscriptions","organizations_url":"https://api.github.com/users/hede/orgs","repos_url":"https://api.github.com/users/hede/repos","events_url":"https://api.github.com/users/hede/events{/privacy}","received_events_url":"https://api.github.com/users/hede/received_events","type":"User","site_admin":false},"repo":{"id":35823173,"name":"MonoGame","full_name":"hede/MonoGame","owner":{"login":"hede","id":512790,"avatar_url":"https://avatars.githubusercontent.com/u/512790?v=3","gravatar_id":"","url":"https://api.github.com/users/hede","html_url":"https://github.com/hede","followers_url":"https://api.github.com/users/hede/followers","following_url":"https://api.github.com/users/hede/following{/other_user}","gists_url":"https://api.github.com/users/hede/gists{/gist_id}","starred_url":"https://api.github.com/users/hede/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hede/subscriptions","organizations_url":"https://api.github.com/users/hede/orgs","repos_url":"https://api.github.com/users/hede/repos","events_url":"https://api.github.com/users/hede/events{/privacy}","received_events_url":"https://api.github.com/users/hede/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/hede/MonoGame","description":"One framework for creating powerful cross-platform games.","fork":true,"url":"https://api.github.com/repos/hede/MonoGame","forks_url":"https://api.github.com/repos/hede/MonoGame/forks","keys_url":"https://api.github.com/repos/hede/MonoGame/keys{/key_id}","collaborators_url":"https://api.github.com/repos/hede/MonoGame/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/hede/MonoGame/teams","hooks_url":"https://api.github.com/repos/hede/MonoGame/hooks","issue_events_url":"https://api.github.com/repos/hede/MonoGame/issues/events{/number}","events_url":"https://api.github.com/repos/hede/MonoGame/events","assignees_url":"https://api.github.com/repos/hede/MonoGame/assignees{/user}","branches_url":"https://api.github.com/repos/hede/MonoGame/branches{/branch}","tags_url":"https://api.github.com/repos/hede/MonoGame/tags","blobs_url":"https://api.github.com/repos/hede/MonoGame/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/hede/MonoGame/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/hede/MonoGame/git/refs{/sha}","trees_url":"https://api.github.com/repos/hede/MonoGame/git/trees{/sha}","statuses_url":"https://api.github.com/repos/hede/MonoGame/statuses/{sha}","languages_url":"https://api.github.com/repos/hede/MonoGame/languages","stargazers_url":"https://api.github.com/repos/hede/MonoGame/stargazers","contributors_url":"https://api.github.com/repos/hede/MonoGame/contributors","subscribers_url":"https://api.github.com/repos/hede/MonoGame/subscribers","subscription_url":"https://api.github.com/repos/hede/MonoGame/subscription","commits_url":"https://api.github.com/repos/hede/MonoGame/commits{/sha}","git_commits_url":"https://api.github.com/repos/hede/MonoGame/git/commits{/sha}","comments_url":"https://api.github.com/repos/hede/MonoGame/comments{/number}","issue_comment_url":"https://api.github.com/repos/hede/MonoGame/issues/comments{/number}","contents_url":"https://api.github.com/repos/hede/MonoGame/contents/{+path}","compare_url":"https://api.github.com/repos/hede/MonoGame/compare/{base}...{head}","merges_url":"https://api.github.com/repos/hede/MonoGame/merges","archive_url":"https://api.github.com/repos/hede/MonoGame/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/hede/MonoGame/downloads","issues_url":"https://api.github.com/repos/hede/MonoGame/issues{/number}","pulls_url":"https://api.github.com/repos/hede/MonoGame/pulls{/number}","milestones_url":"https://api.github.com/repos/hede/MonoGame/milestones{/number}","notifications_url":"https://api.github.com/repos/hede/MonoGame/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/hede/MonoGame/labels{/name}","releases_url":"https://api.github.com/repos/hede/MonoGame/releases{/id}","created_at":"2015-05-18T14:37:58Z","updated_at":"2015-05-18T14:38:04Z","pushed_at":"2016-01-05T16:52:53Z","git_url":"git://github.com/hede/MonoGame.git","ssh_url":"git@github.com:hede/MonoGame.git","clone_url":"https://github.com/hede/MonoGame.git","svn_url":"https://github.com/hede/MonoGame","homepage":"http://www.monogame.net","size":51581,"stargazers_count":0,"watchers_count":0,"language":"C#","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"develop"}},"base":{"label":"mono:develop","ref":"develop","sha":"c043c186bdf42165ad0c3f04163a4dc97010af79","user":{"login":"mono","id":53395,"avatar_url":"https://avatars.githubusercontent.com/u/53395?v=3","gravatar_id":"","url":"https://api.github.com/users/mono","html_url":"https://github.com/mono","followers_url":"https://api.github.com/users/mono/followers","following_url":"https://api.github.com/users/mono/following{/other_user}","gists_url":"https://api.github.com/users/mono/gists{/gist_id}","starred_url":"https://api.github.com/users/mono/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mono/subscriptions","organizations_url":"https://api.github.com/users/mono/orgs","repos_url":"https://api.github.com/users/mono/repos","events_url":"https://api.github.com/users/mono/events{/privacy}","received_events_url":"https://api.github.com/users/mono/received_events","type":"Organization","site_admin":false},"repo":{"id":1579990,"name":"MonoGame","full_name":"mono/MonoGame","owner":{"login":"mono","id":53395,"avatar_url":"https://avatars.githubusercontent.com/u/53395?v=3","gravatar_id":"","url":"https://api.github.com/users/mono","html_url":"https://github.com/mono","followers_url":"https://api.github.com/users/mono/followers","following_url":"https://api.github.com/users/mono/following{/other_user}","gists_url":"https://api.github.com/users/mono/gists{/gist_id}","starred_url":"https://api.github.com/users/mono/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mono/subscriptions","organizations_url":"https://api.github.com/users/mono/orgs","repos_url":"https://api.github.com/users/mono/repos","events_url":"https://api.github.com/users/mono/events{/privacy}","received_events_url":"https://api.github.com/users/mono/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/mono/MonoGame","description":"One framework for creating powerful cross-platform games.","fork":false,"url":"https://api.github.com/repos/mono/MonoGame","forks_url":"https://api.github.com/repos/mono/MonoGame/forks","keys_url":"https://api.github.com/repos/mono/MonoGame/keys{/key_id}","collaborators_url":"https://api.github.com/repos/mono/MonoGame/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/mono/MonoGame/teams","hooks_url":"https://api.github.com/repos/mono/MonoGame/hooks","issue_events_url":"https://api.github.com/repos/mono/MonoGame/issues/events{/number}","events_url":"https://api.github.com/repos/mono/MonoGame/events","assignees_url":"https://api.github.com/repos/mono/MonoGame/assignees{/user}","branches_url":"https://api.github.com/repos/mono/MonoGame/branches{/branch}","tags_url":"https://api.github.com/repos/mono/MonoGame/tags","blobs_url":"https://api.github.com/repos/mono/MonoGame/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/mono/MonoGame/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/mono/MonoGame/git/refs{/sha}","trees_url":"https://api.github.com/repos/mono/MonoGame/git/trees{/sha}","statuses_url":"https://api.github.com/repos/mono/MonoGame/statuses/{sha}","languages_url":"https://api.github.com/repos/mono/MonoGame/languages","stargazers_url":"https://api.github.com/repos/mono/MonoGame/stargazers","contributors_url":"https://api.github.com/repos/mono/MonoGame/contributors","subscribers_url":"https://api.github.com/repos/mono/MonoGame/subscribers","subscription_url":"https://api.github.com/repos/mono/MonoGame/subscription","commits_url":"https://api.github.com/repos/mono/MonoGame/commits{/sha}","git_commits_url":"https://api.github.com/repos/mono/MonoGame/git/commits{/sha}","comments_url":"https://api.github.com/repos/mono/MonoGame/comments{/number}","issue_comment_url":"https://api.github.com/repos/mono/MonoGame/issues/comments{/number}","contents_url":"https://api.github.com/repos/mono/MonoGame/contents/{+path}","compare_url":"https://api.github.com/repos/mono/MonoGame/compare/{base}...{head}","merges_url":"https://api.github.com/repos/mono/MonoGame/merges","archive_url":"https://api.github.com/repos/mono/MonoGame/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/mono/MonoGame/downloads","issues_url":"https://api.github.com/repos/mono/MonoGame/issues{/number}","pulls_url":"https://api.github.com/repos/mono/MonoGame/pulls{/number}","milestones_url":"https://api.github.com/repos/mono/MonoGame/milestones{/number}","notifications_url":"https://api.github.com/repos/mono/MonoGame/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/mono/MonoGame/labels{/name}","releases_url":"https://api.github.com/repos/mono/MonoGame/releases{/id}","created_at":"2011-04-07T00:23:40Z","updated_at":"2016-01-05T11:48:37Z","pushed_at":"2016-01-05T19:01:09Z","git_url":"git://github.com/mono/MonoGame.git","ssh_url":"git@github.com:mono/MonoGame.git","clone_url":"https://github.com/mono/MonoGame.git","svn_url":"https://github.com/mono/MonoGame","homepage":"http://www.monogame.net","size":330856,"stargazers_count":3105,"watchers_count":3105,"language":"C#","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1682,"mirror_url":null,"open_issues_count":700,"forks":1682,"open_issues":700,"watchers":3105,"default_branch":"develop"}},"_links":{"self":{"href":"https://api.github.com/repos/mono/MonoGame/pulls/4390"},"html":{"href":"https://github.com/mono/MonoGame/pull/4390"},"issue":{"href":"https://api.github.com/repos/mono/MonoGame/issues/4390"},"comments":{"href":"https://api.github.com/repos/mono/MonoGame/issues/4390/comments"},"review_comments":{"href":"https://api.github.com/repos/mono/MonoGame/pulls/4390/comments"},"review_comment":{"href":"https://api.github.com/repos/mono/MonoGame/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/mono/MonoGame/pulls/4390/commits"},"statuses":{"href":"https://api.github.com/repos/mono/MonoGame/statuses/f40ca4383f29338d0e7adb5f5903d4f8d06e84b9"}}}}