b80f0e84e7
* Use a relative path for docs index page logo Changes the paths for the logo on the index page of the documentation to use relative links instead of absolute ones. The current absolute path is just fine as long as the site is not hosted under another directory. When opening files locally (without serving them in docfx) these images will fail to load. In addition, if these files are served under a directory that is not the root endpoint (like: `docs.com/stable/`) the images will also break. I tested these changes locally using these steps: - Build & serve docs: `docfx docs/docfx.json --serve` - Verify that logo shows up on index page using all 3 themes - Open `docs/_site/index.html` - Verify logo works on all 3 themes * Minor grammar fix in DiscordSocketClient
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--serveparameter 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.