{"push_id":2919608983,"size":1,"distinct_size":1,"ref":"refs/heads/dev","head":"ff0fea98a65d907fbce07856f1a9ef4aebb9108b","before":"6b21b11f7d2fe4ffb93ae6c394d78bc7c7dcb75b","commits":[{"sha":"ff0fea98a65d907fbce07856f1a9ef4aebb9108b","author":{"name":"Still Hsu","email":"44c04e03ce6b17659be1264916f021f8b95df1fd@gmail.com"},"message":"Documentation Overhaul (#1161)\n\n* Add XML docs\r\n\r\n* Clean up style switcher\r\n\r\n* Squash commits on branch docs/faq-n-patches\r\n\r\n* Fix broken theme selector\r\n\r\n* Add local image embed instruction\r\n\r\n* Add a bunch of XML docs\r\n\r\n* Add a bunch of XML docs\r\n\r\n* Fix broken search\r\n+ DocFX by default ships with an older version of jQuery, switching to a newer version confuses parts of the DocFX Javascript.\r\n\r\n* Minor fixes for CONTRIBUTING.md and README.md\r\n\r\n* Clean up filterConfig.yml\r\n\r\n+ New config exposes Discord.Net namespace since it has several common public exceptions that may be helpful to users\r\n\r\n* Add XML docs\r\n\r\n* Read token from Environment Variable instead of hardcode\r\n\r\n* Add XMLDocs\r\n\r\n* Compress some assets & add OAuth2 URL generator\r\n\r\n* Fix sample link & add missing pictures\r\n\r\n* Add tag examples\r\n\r\n* Fix embed docs consistency\r\n\r\n* Add details regarding userbot support\r\n\r\n* Add XML Docs\r\n\r\n* Add XML Docs\r\n\r\n* Add XML Docs\r\n\r\n* Minor fixes in documentations\r\n+ Fix unescaped '<'\r\n+ Fix typo\r\n\r\n* Fix seealso for preconditions and add missing descriptions\r\n\r\n* Add missing exceptions\r\n\r\n* Document exposed TypeReaders\r\n\r\n* Fix letter-casing for files\r\n\r\n* Add 'last modified' plugin\r\n\r\nSource: https://github.com/Still34/DocFx.Plugin.LastModified\r\nLicensed under MIT License\r\n\r\n* XML Docs\r\n\r\n* Fix minor consistencies & redundant impl\r\n\r\n* Add properties examples to overwrite\r\n\r\n* Fix missing Username prop\r\n\r\n* Add warning for bulk-delete endpoint\r\n\r\n* Replace note block\r\n\r\n* Add BaseSocketClient docs\r\n\r\n* Add XML docs\r\n\r\n* Replace langword null to code block null instead\r\n\r\n- Because DocFX sucks at rendering langword\r\n\r\n* Replace all langword placements with code block\r\n\r\n* Add more IGuild docs\r\n\r\n* Add details to SpotifyGame\r\n\r\n* Initial proofread of the articles\r\n\r\n* Add explanation for RunMode\r\n\r\n* Add event docs\r\n\r\n- MessageReceived\r\n- ChannelUpdated/Destroyed/Created\r\n\r\n* Fix light theme link color\r\n\r\n* Fix xml docs error\r\n\r\n* Add partial documentation for audit log impl\r\n\r\n* Add documentation for some REST-based objects\r\n\r\n* Add partial documentation for audit log objects\r\n\r\n* Add more XML comments to quotation mark alias map stuff, including an example\r\n\r\n* Add reference to CommandServiceConfig from the util docs'\r\n\r\n* Add explanation that if \" is removed then it wont work\r\n\r\n* Fix missing service provider in example\r\n\r\n* Add documentation for new INestedChannel\r\n\r\n* Add documentation\r\n\r\n* Add documentation for new API version & few events\r\n\r\n* Revise guide paragraphs/samples\r\n\r\n+ Fix various formatting.\r\n+ Provide a more detailed walkthrough for dependency injection.\r\n+ Add C# note at intro.\r\n\r\n* Fix typos & formatting\r\n\r\n* Improve group module example\r\n\r\n* Small amount to see if I'm doing it right\r\n\r\n* Remove/cleanup redundant variables\r\n\r\n* Fix EnterTypingState impl for doc inheritance\r\n\r\n* Fix Test to resolve changes made in 15b58e\r\n\r\n* Improve precondition documentation\r\n\r\n+ Add precondition usage sample\r\n+ Add precondition group usage sample\r\n+ Move precondition samples to its own sample folder\r\n\r\n* Move samples to individual folders\r\n\r\n* Clarify token source\r\n\r\n* Cleanup styling of README.md for docs\r\n\r\n* Replace InvalidPathChars for NS1.3\r\n\r\n* InvalidPathChars does not exist in NS1.3; replaced with GetInvalidPathChars instead.\r\n\r\n* Add a missing change for 2c7cc738\r\n\r\n* Update LastModified to v1.1.0 & add license\r\n\r\n* Rewrite installation page for Core 2.1\r\n\r\n* Fix anchor link\r\n\r\n* Bump post-processor to v1.1.1\r\n\r\n* Add fixes to partial file & add license\r\n\r\n* Moved theme-switcher code to scripts partial file\r\n+ Add author's MIT license to featherlight javascript\r\n\r\n* Remove unused bootstrap plugin\r\n\r\n* Bump LastModified plugin\r\n\r\n* Changed the path from 'lastmodified' to 'last-modified' for consistency\r\n\r\n* Cleanup README & Contribution guide\r\n\r\n* Changes to last pr\r\n\r\n* Fix GetCategoryAsync docs\r\n\r\n* Proofread and cleanup articles\r\n\r\n* Change passive voice in \"Get Started\" to active\r\n* Fix improper preposition in Commands Introduction page\r\n* Fix minor grammar mistakes in \"Your First Bot\" (future tense -> present tense/subjunctive mood -> indicative mood/proper noun casing/incorrect noun/add missing article)\r\n* Fix minor grammar mistakes in \"Installation\" (missing article)\r\n\r\n* no hablo ingles\r\n\r\n* Try try try again\r\n\r\n* I'm sure you're having as much fun as I am\r\n\r\n* Cleanup TOC & fix titles\r\n\r\n* Improve styling\r\n\r\n+ Change title font to Noto Sans\r\n+ Add materialized design for commit message box\r\n\r\n* Add DescriptionGenerator plugin\r\n\r\n* Add nightly section for clarification\r\n\r\n* Fix typos in Nightlies & Post-execution\r\n\r\n* Bump DescriptionGenerator to v1.1.0\r\n\r\n+ This build adds the functionality of generating managed references' summary into the description tag.\r\n\r\n* Initial emoji article draft\r\n\r\n* Add 'additional information' section for emoji article\r\n\r\n* Add cosmetic changes to the master css\r\n\r\n* Alter info box color\r\n+ Add transition to article content\r\n\r\n* Add clarification in the emoji article\r\n\r\n* Emphasize that normal emoji string will not translate to its Unicode representation.\r\n* Clean up or add some of the samples featured in the article.\r\n+ Add emoji/emote declaration section for clarification.\r\n+ Add WebSocket emote sample.\r\n- Remove inconsistent styling ('wacky memes' proves to be too out of place).\r\n\r\n* Improve readability for nightlies article\r\n\r\n* Move 'Bundled Preconditions' section\r\n\r\n* Bump LastModified to fix UTC DateTime parsing\r\n\r\n* Add langwordMapping.yml\r\n\r\n* Add XML docs\r\n\r\n* Add VSC workspace rule\r\n\r\n* The root workspace limits the ruler to 120 characters for member documentations and excludes folders such as 'samples' and 'docs'.\r\n* The docs workspace limits the ruler to 70 characters for standard conceptual article to comply with documentation's CONTRIBUTING.md rule, and excludes temprorary folders created by DocFX.\r\n\r\n* Update CONTRIBUTING.md\r\n\r\n* Add documentation style rule\r\n\r\n* Fix styling of several member documentation\r\n\r\n* Fix ' />' caused by Agent Smith oddities\r\n* Fix styling to be more specific about the mention of IDs\r\n\r\n* Fix exception summary to comply with official Microsoft Docs style\r\n\r\n* References\r\nhttps://docs.microsoft.com/en-us/dotnet/api/system.argumentnullexception?view=netframework-4.7.2\r\nhttps://docs.microsoft.com/en-us/dotnet/api/system.platformnotsupportedexception?view=netframework-4.7.2\r\nhttps://docs.microsoft.com/en-us/dotnet/api/system.badimageformatexception?view=netframework-4.7.2\r\n\r\n* Add XML documentations\r\n\r\n* Shift color return docs\r\n\r\n* Fix minor docs\r\n\r\n* Added documentation for SocketDMChannel, SocketGuildChannel, and SocketTextChannel\r\n\r\n* Add XML docs\r\n\r\n* Corrections to SocketGuildChannel\r\n\r\n* Corrections to SocketTextChannel\r\n\r\n* Corrections to SocketDMChannel\r\n\r\n* Swapped out 'id' for 'snowflake identifier\r\n\r\n* Swapped out 'id' for 'snowflake identifier'\r\n\r\n* SocketDMChannel amendments\r\n\r\n* SocketGuildChannel amendments\r\n\r\n* SocketTextChannel amendments\r\n\r\n* Add XML docs & patch return types\r\n+ Starting from this commit, all return types for tasks will use style similar to most documentations featured on docs.microsoft.com\r\n\r\nReferences:\r\nhttps://docs.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.dbcontext.-ctor?view=efcore-2.1\r\nhttps://docs.microsoft.com/en-us/dotnet/api/system.io.filestream.readasync?view=netcore-2.1\r\nhttps://docs.microsoft.com/en-us/dotnet/api/system.io.textwriter.writelineasync?view=netcore-2.1#System_IO_TextWriter_WriteLineAsync_System_Char___\r\nAnd many more other asynchronous method documentations featured in the latest BCL.\r\n\r\n* Added documentation for many audit log data types, fixed vowel indefinite articles\r\n\r\n* Change audit log data types to start with 'Contains' (verb) instead of an article\r\n\r\n* Fix some documentation issues and document some more audit log data types\r\n\r\n* Fix English posession\r\n\r\n* Add XML doc\r\n\r\n* Documented two more types\r\n\r\n* Documented RoleCreateAuditLogData\r\n\r\n* Document remaining audit log data types\r\n\r\n* Added RestDMChannel documentation\r\n\r\n* Added RestGuildChannel documentation\r\n\r\n* Added RestTextChannel documentation\r\n\r\n* Added RestVoiceChannel documentation\r\n\r\n* Added RestUser documentation\r\n\r\n* Added RestRole documentation\r\n\r\n* Added RestMessage documentation\r\n\r\n* Slightly better wording\r\n\r\n* Contains -> Contains a piece of (describe article)\r\n\r\n* [EN] Present perf. -> past perf.\r\n\r\n* Add XML docs\r\n\r\n* Fix arrow alignment\r\n\r\n* Clarify supported nullable type\r\n\r\n* Fixed a typo in ISnowflakeEntity\r\n\r\n* Added RestUser Documentation\r\n\r\n* Added RestInvite documentation\r\n\r\n* Add XML docs & minor optimizations\r\n\r\n* Minor optimization for doc rendering\r\n\r\n* Rollback font optimization changes\r\n\r\n* Amendments to RestUser\r\n\r\n* Added SocketDMChannel documentation\r\n\r\n* Added RestDMChannel documentation\r\n\r\n* Added RestGuild documentation\r\n\r\n* Adjustment to SocketDMChannel\r\n\r\n* Added minimal descriptions from the API documentation for Integration types\r\n\r\n* Added obsolete mention to the ReadMessages flag.\r\n\r\n* Added remarks about 2FA requirement for guild permissions\r\n\r\n* Added xmldoc for GuildPermission methods\r\n\r\n* Added xml doc for ToAllowList and ToDenyList\r\n\r\n* Added specification of how the bits of the color raw value are packed\r\n\r\n* Added discord API documentation to IConnection interface\r\n\r\n* I can spell :^)\r\n\r\n* Fix whitespace in ChannelPermission\r\n\r\n* fix spacing of values in guildpermission\r\n\r\n* Made changes to get field descriptions from feedback, added returns tag to IConnection\r\n\r\n* Added property get standard for IntegrationAccount\r\n\r\n* Added property get pattern to xml docs and identical returns tag.\r\n\r\n* Change all color class references to struct\r\n...because it isn't a class.\r\n\r\n* Add XML docs\r\n\r\n* Rewrote the returns tags in IGuildIntegration, removed the ones I was unsure about.\r\n\r\n* Rewrote the rest of the returns tags\r\n\r\n* Amendments\r\n\r\n* Cleanup doc for c1d78189\r\n\r\n* Added types to <returns> tags where missing\r\n\r\n* Added second sample for adding reactions\r\n\r\n* Added some class summaries\r\n\r\n* Missed a period\r\n\r\n* Amendments\r\n\r\n* restored the removed line break\r\n\r\n* Removed unnecessary see tag\r\n\r\n* Use consistent quotation marks around subscribers, the name for these users are dependant on the source of where they are integrated from (youtube or twitch), so we should not use a name that is specific to one platform\r\n\r\n* Add <remarks> tag to the IGuildIntegration xmldocs\r\n\r\n* Fix grammar issue\r\n\r\n* Update DescriptionGenerator\r\n\r\n* Cleanup of https://github.com/Still34/Discord.Net/pull/8\r\n\r\n* Cleanup previous PR\r\n\r\n* Fix for misleading behaviour in the emoji guide\r\n+ Original lines stated that sending a emoji wrapped in colon will not be parsed, but that was incorrect; replaced with reactions instead of sending messages as the example\r\n\r\n* Add strings for dictionary in DotSettings\r\n\r\n* Add XML docs\r\n\r\n* Fix lots of typos in comments\r\n+ Geez, I didn't know there were so many.\r\n\r\n* Add XML docs & rewrite GetMessagesAsync docs\r\n\r\nThis commit rewrites the remarks section of GetMessagesAsync, as well as adding examples to several methods.\r\n\r\n* Update 'Your First Bot'\r\n+ This commit reflects the new changes made to the Discord Application Developer Portal after its major update\r\n\r\n* Initial optimization for DocFX render & add missing files\r\n\r\n* Add examples in message methods\r\n\r\n* Cleanup https://github.com/RogueException/Discord.Net/pull/1128\r\n\r\n* Fix first bot note\r\n\r\n* Cleanup FAQ structure\r\n\r\n* Add XML docs\r\n\r\n* Update docfx plugins\r\n\r\n* Fix navbar collapsing issue\r\n\r\n* Fix broken xref\r\n\r\n* Cleanup FAQ section\r\n+ Add introductory paragraphs to each FAQ section.\r\n+ Add 'missing dependency' entry to commands FAQ.\r\n* Split commands FAQ to 'General' and 'DI' sections.\r\n\r\n* Cleanup https://github.com/RogueException/Discord.Net/pull/1139\r\n\r\n* Fix missing namespace\r\n\r\n* Add missing highlighting css for the light theme\r\n\r\n* Add additional clarification for installing packages\r\n\r\n* Add indentation to example for clarity\r\n\r\n* Cleanup several articles to be more human-friendly and easier to read\r\n\r\n* Remove RPC-related notes\r\n\r\n* Cleanup slow-mode-related documentation strings\r\n\r\n* Add an additional note about cross-guild emote usage\r\n\r\n* Add CreateTextChannel sample\r\n\r\n* Add XMLDocs","distinct":true,"url":"https://api.github.com/repos/RogueException/Discord.Net/commits/ff0fea98a65d907fbce07856f1a9ef4aebb9108b"}]}
{"actor":{"display_login":"foxbot"}}