From 2b53c7bf7d1beeb65ff9fe97f0b2fcfb69817e79 Mon Sep 17 00:00:00 2001 From: Marc Gravell Date: Tue, 18 Aug 2026 14:06:24 +0100 Subject: [PATCH 1/3] Add a Jekyll config for the docs site, and switch to Cayman The site had no _config.yml at all, so it ran on GitHub's defaults: the Primer theme, and a site title/description quietly sourced from the repo's name and description fields - meaning an edit in the repo settings UI changed the site's metadata. This pins both, pins the URL, and picks a theme deliberately. Also opts into jekyll-sitemap (not part of the always-on GitHub Pages plugin set), which gives us the sitemap.xml and robots.txt the site was missing, and excludes docs.csproj, which was being published as site content. Claude-Session: https://claude.ai/code/session_01NxkjXSR7CSGzyw89tJJVtw --- docs/_config.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/_config.yml diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..e3bd6dbc8 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,22 @@ +# Jekyll config for the published docs site (https://seredis.dev). +# Without this file the site runs on GitHub's defaults: the Primer theme, and site +# title/description silently taken from the repo's name and description fields. + +title: StackExchange.Redis +description: The Redis client for .NET +url: https://seredis.dev + +theme: jekyll-theme-cayman + +# Cayman renders "Download .zip/.tar.gz" buttons in its header when this is on, and +# GitHub's default config turns it on; the package comes from NuGet, not a tarball. +show_downloads: false + +# Not in the always-on GitHub Pages plugin set, so it has to be asked for; generates +# sitemap.xml and robots.txt, neither of which the site had. +plugins: + - jekyll-sitemap + +# Present only so the docs show up in the solution; not site content. +exclude: + - docs.csproj From bfc1ec74f274c27039f525e55c0b0f3875c459e9 Mon Sep 17 00:00:00 2001 From: Marc Gravell Date: Tue, 18 Aug 2026 14:08:43 +0100 Subject: [PATCH 2/3] Point the docs index at GitHub Releases for release notes ReleaseNotes.md is frozen at 3.0 - it says so itself in its first entry - so the index was sending people to a page whose top line tells them to go somewhere else. Make Releases the primary link and keep the old page in parentheses for the historical record. Claude-Session: https://claude.ai/code/session_01NxkjXSR7CSGzyw89tJJVtw --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 36c032c57..93c6eab7d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ StackExchange.Redis =================== -- [Release Notes](ReleaseNotes) +- [Release Notes](https://github.com/StackExchange/StackExchange.Redis/releases) (3.0 onwards; [earlier releases](ReleaseNotes)) ## Overview From f1ef2256a8c4329f2c5407c11abb3a0456458565 Mon Sep 17 00:00:00 2001 From: Marc Gravell Date: Tue, 18 Aug 2026 14:09:43 +0100 Subject: [PATCH 3/3] Point the READMEs at GitHub Releases for release notes Same fix as the docs index, in the two remaining places that sent people to the frozen page - including the README embedded in the NuGet package, which is the one most readers actually see. PackageReleaseNotes already pointed at Releases, so the package metadata and its README now agree. Claude-Session: https://claude.ai/code/session_01NxkjXSR7CSGzyw89tJJVtw --- README.md | 2 +- src/StackExchange.Redis/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 53496aa6b..f8c6c4fbd 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,4 @@ MyGet Pre-release feed: https://www.myget.org/gallery/stackoverflow | ------- | ------------ | ----------------- | --------- | ----- | | [StackExchange.Redis](https://www.nuget.org/packages/StackExchange.Redis/) | [![StackExchange.Redis](https://img.shields.io/nuget/v/StackExchange.Redis.svg)](https://www.nuget.org/packages/StackExchange.Redis/) | [![StackExchange.Redis](https://img.shields.io/nuget/vpre/StackExchange.Redis.svg)](https://www.nuget.org/packages/StackExchange.Redis/absoluteLatest) | [![StackExchange.Redis](https://img.shields.io/nuget/dt/StackExchange.Redis.svg)](https://www.nuget.org/packages/StackExchange.Redis/) | [![StackExchange.Redis MyGet](https://img.shields.io/myget/stackoverflow/vpre/StackExchange.Redis.svg)](https://www.myget.org/feed/stackoverflow/package/nuget/StackExchange.Redis) | -Release notes at: https://seredis.dev/ReleaseNotes +Release notes at: https://github.com/StackExchange/StackExchange.Redis/releases (3.0 onwards; earlier releases at https://seredis.dev/ReleaseNotes) diff --git a/src/StackExchange.Redis/README.md b/src/StackExchange.Redis/README.md index 0d4f09f6f..743cd1ef3 100644 --- a/src/StackExchange.Redis/README.md +++ b/src/StackExchange.Redis/README.md @@ -1,6 +1,6 @@ StackExchange.Redis is a high-performance RESP (Redis, etc) client for .NET, available under the MIT license. -- Release notes: [https://seredis.dev/ReleaseNotes](https://seredis.dev/ReleaseNotes) +- Release notes: [https://github.com/StackExchange/StackExchange.Redis/releases](https://github.com/StackExchange/StackExchange.Redis/releases) (3.0 onwards; [earlier](https://seredis.dev/ReleaseNotes)) - NuGet package: [https://www.nuget.org/packages/StackExchange.Redis/](https://www.nuget.org/packages/StackExchange.Redis/) - General docs: [https://seredis.dev/](https://seredis.dev/) - Code: [https://github.com/StackExchange/StackExchange.Redis/](https://github.com/StackExchange/StackExchange.Redis/) \ No newline at end of file