From b80f0e84e78714653a1cc89d048c543740ba6522 Mon Sep 17 00:00:00 2001 From: Chris Johnston Date: Sat, 16 Mar 2019 11:35:45 -0700 Subject: [PATCH] docs: Use a relative path for docs index page logo (#1276) * 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 --- docs/_template/light-dark-theme/styles/dark.css | 2 +- docs/_template/light-dark-theme/styles/gray.css | 2 +- docs/_template/light-dark-theme/styles/light.css | 2 +- src/Discord.Net.WebSocket/DiscordSocketClient.cs | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/_template/light-dark-theme/styles/dark.css b/docs/_template/light-dark-theme/styles/dark.css index 8ae0049d..54ad76c7 100644 --- a/docs/_template/light-dark-theme/styles/dark.css +++ b/docs/_template/light-dark-theme/styles/dark.css @@ -304,5 +304,5 @@ span.arrow-r{ } .logo-switcher { - background: url("/marketing/logo/SVG/Combinationmark White.svg") no-repeat; + background: url("../marketing/logo/SVG/Combinationmark White.svg") no-repeat; } diff --git a/docs/_template/light-dark-theme/styles/gray.css b/docs/_template/light-dark-theme/styles/gray.css index 32ff7d20..4cb65878 100644 --- a/docs/_template/light-dark-theme/styles/gray.css +++ b/docs/_template/light-dark-theme/styles/gray.css @@ -311,5 +311,5 @@ span.arrow-r{ } .logo-switcher { - background: url("/marketing/logo/SVG/Combinationmark White.svg") no-repeat; + background: url("../marketing/logo/SVG/Combinationmark White.svg") no-repeat; } diff --git a/docs/_template/light-dark-theme/styles/light.css b/docs/_template/light-dark-theme/styles/light.css index 71910e77..a2ba3078 100644 --- a/docs/_template/light-dark-theme/styles/light.css +++ b/docs/_template/light-dark-theme/styles/light.css @@ -113,5 +113,5 @@ span.arrow-r{ } .logo-switcher { - background: url("/marketing/logo/SVG/Combinationmark.svg") no-repeat; + background: url("../marketing/logo/SVG/Combinationmark.svg") no-repeat; } diff --git a/src/Discord.Net.WebSocket/DiscordSocketClient.cs b/src/Discord.Net.WebSocket/DiscordSocketClient.cs index 196aedf4..96286d31 100644 --- a/src/Discord.Net.WebSocket/DiscordSocketClient.cs +++ b/src/Discord.Net.WebSocket/DiscordSocketClient.cs @@ -83,7 +83,7 @@ namespace Discord.WebSocket /// /// /// - /// An collection of DM channels that have been opened in this session. + /// A collection of DM channels that have been opened in this session. /// public IReadOnlyCollection DMChannels => State.PrivateChannels.OfType().ToImmutableArray(); @@ -98,7 +98,7 @@ namespace Discord.WebSocket /// /// /// - /// An collection of group channels that have been opened in this session. + /// A collection of group channels that have been opened in this session. /// public IReadOnlyCollection GroupChannels => State.PrivateChannels.OfType().ToImmutableArray();