Files

Still Hsu fd3810e9fe docs: September 2019 Documentation Update (#1379 )

* docs: adjust wording of ActivityType.Watching enum

Adjusts the xmldoc summary wording of the ActivityType.Watching enum to
fix a wording issue.

* Add D.NET Logo to Open Graph meta tags

* Update DescriptionGenerator
...And update color to suit the logo better

* Disable smooth scrolling due to user complaints

* Remove unnecessary spacing in sideaffix

* Update footer version

* Remove featherlight plugin

As it is unnecessary and can break image tags

* Adjust wordings regarding safe-handling of secrets

* Fix formatting for first bot token sample

* Add badges to homepage

* Minor wording fixes on terminal

* Update to higher quality PNG

* Add Discord.Net.Example in sln for build validation

* Clarify all instances of IAsnycEnumerable

* Clarify overridden props in SocketNewsChannel

* Add returns and params docs for SyncPermissionsAsync

* Remove/fix invalid XMLdoc strings

* Remove AppVeyor and add GitHub badge

2019-09-22 19:06:57 -04:00

_overwrites

docs: Main docs update (#1304 )

2019-05-13 18:29:47 -04:00

_template

docs: September 2019 Documentation Update (#1379 )

2019-09-22 19:06:57 -04:00

api

Documentation Overhaul (#1161 )

2018-09-30 17:44:33 -04:00

faq

docs: Documentation December Update (#1218 )

2018-12-28 08:49:02 -08:00

guides

docs: September 2019 Documentation Update (#1379 )

2019-09-22 19:06:57 -04:00

marketing/logo

docs: September 2019 Documentation Update (#1379 )

2019-09-22 19:06:57 -04:00

.gitignore

Clean up commands documentation; index

2016-07-22 13:08:26 -04:00

CONTRIBUTING.md

docs: Main docs update (#1304 )

2019-05-13 18:29:47 -04:00

Discord.Net.Docs.code-workspace

Documentation Overhaul (#1161 )

2018-09-30 17:44:33 -04:00

docfx.json

docs: September 2019 Documentation Update (#1379 )

2019-09-22 19:06:57 -04:00

favicon.ico

docs: Documentation December Update (#1218 )

2018-12-28 08:49:02 -08:00

filterConfig.yml

docs: Main docs update (#1304 )

2019-05-13 18:29:47 -04:00

index.md

docs: September 2019 Documentation Update (#1379 )

2019-09-22 19:06:57 -04:00

langwordMapping.yml

Documentation Overhaul (#1161 )

2018-09-30 17:44:33 -04:00

README.md

Documentation Overhaul (#1161 )

2018-09-30 17:44:33 -04:00

toc.yml

docs: Documentation December Update (#1218 )

2018-12-28 08:49:02 -08:00

README.md

Instructions for Building Documentation

The documentation for the Discord.Net library uses DocFX. Instructions for installing this tool can be found here.

Navigate to the root of the repository.
Build the docs using docfx docs/docfx.json. Add the --serve parameter to preview the site locally. Some elements of the page may appear incorrectly when hosted offline.

Please note that if you intend to target a specific version, ensure that you have the correct version checked out.