Skip to content

Pin the docs site config, and give it a favicon - #2224

Merged
mgravell merged 1 commit into
mainfrom
marc/docs-polish
Aug 18, 2026
Merged

Pin the docs site config, and give it a favicon#2224
mgravell merged 1 commit into
mainfrom
marc/docs-polish

Conversation

@mgravell

Copy link
Copy Markdown
Member

The docs site has been running on GitHub's defaults. That mostly works - the always-on plugin set does real work for us (jekyll-optional-front-matter is why front-matter-less markdown renders, jekyll-relative-links is why inter-doc links resolve, jekyll-titles-from-headings is where page titles come from) - but a few things fall out of it.

Site metadata came from the repo settings UI. jekyll-github-metadata fills site.title from the repo name and site.description from the repo description field, so editing the description on the repo page silently changed the site's <meta name="description"> and its Open Graph tags. Both are pinned now, along with url, which is what jekyll-seo-tag uses to build canonical and og:url.

No sitemap. jekyll-sitemap is not in the always-on set and has to be asked for; sitemap.xml and robots.txt both 404 today. Opting in generates both.

No favicon. The theme's head includes head-custom.html and ships a version with the favicon line commented out, so overriding that file is the intended hook. Built from the project logo. Modern browsers get the 256px PNG, everything else a 16/32/48 .ico at the site root, where the browser's automatic /favicon.ico probe finds it regardless of markup. Checked that it still reads at 16px on light and dark tab backgrounds.

The page title was printing twice. The theme renders the page title in its header banner, and that title is derived from the page's first heading - which is still in the body. titles_from_headings.strip_title drops the heading from the body once it has been promoted. The banner is unaffected, and the markdown keeps its headings, so GitHub's own rendering is unchanged.

Theme is unchanged (already Cayman).

There is no Ruby toolchain to hand, so this could not be rendered locally - worth a look on the deployed site once it lands.

The site was running on GitHub's defaults, which take the title and description
from the repo's name and description fields - so an edit in the repo settings UI
quietly changed the site's metadata. Those are pinned now, along with the URL,
which is what jekyll-seo-tag uses to build canonical and og:url.

Also: strip_title, so the page title stops being printed twice (once in the
theme's header banner, once as the heading it was derived from); jekyll-sitemap,
which is not in the always-on GitHub Pages plugin set, for the sitemap.xml and
robots.txt the site did not have; and a favicon built from the project logo,
hooked up via the head-custom.html include the theme provides for exactly this.

Claude-Session: https://claude.ai/code/session_01NxkjXSR7CSGzyw89tJJVtw
@mgravell
mgravell merged commit c0b2097 into main Aug 18, 2026
1 of 3 checks passed
@mgravell
mgravell deleted the marc/docs-polish branch August 18, 2026 13:42
This was referenced Sep 12, 2026
This was referenced Sep 14, 2026
github-actions Bot pushed a commit to sloweyyy/cloud-native-ecommerce-platform that referenced this pull request Sep 14, 2026
Updated [Dapper](https://github.com/DapperLib/Dapper) from 2.1.79 to
2.1.86.

<details>
<summary>Release notes</summary>

_Sourced from [Dapper's
releases](https://github.com/DapperLib/Dapper/releases)._

## 2.1.86

## What's Changed
* Point docs links at dapperlib.dev by @​mgravell in
DapperLib/Dapper#2222
* Point PackageReleaseNotes at GitHub Releases by @​mgravell in
DapperLib/Dapper#2223
* Pin the docs site config, and give it a favicon by @​mgravell in
DapperLib/Dapper#2224
* DynamicParameters.AddParameters(IDbCommand): identity-free self-apply
by @​mgravell in DapperLib/Dapper#2225
* Re-enable DateOnly/TimeOnly support, fixing the defects that got it
disabled by @​mgravell in DapperLib/Dapper#2228
* Publish to nuget.org via Trusted Publishing (OIDC), and retire
MyGet/AppVeyor by @​mgravell in
DapperLib/Dapper#2230


**Full Changelog**:
DapperLib/Dapper@2.1.79...2.1.86

Commits viewable in [compare
view](DapperLib/Dapper@2.1.79...2.1.86).
</details>

Updated
[Microsoft.Extensions.Configuration.Abstractions](https://github.com/dotnet/dotnet)
from 10.0.11 to 10.0.12.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.Extensions.Configuration.Abstractions's
releases](https://github.com/dotnet/dotnet/releases)._

No release notes found for this version range.

Commits viewable in [compare
view](https://github.com/dotnet/dotnet/commits).
</details>

Updated
[Microsoft.Extensions.Configuration.Binder](https://github.com/dotnet/dotnet)
from 10.0.11 to 10.0.12.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.Extensions.Configuration.Binder's
releases](https://github.com/dotnet/dotnet/releases)._

No release notes found for this version range.

Commits viewable in [compare
view](https://github.com/dotnet/dotnet/commits).
</details>

Updated
[Microsoft.Extensions.DependencyInjection.Abstractions](https://github.com/dotnet/dotnet)
from 10.0.11 to 10.0.12.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.Extensions.DependencyInjection.Abstractions's
releases](https://github.com/dotnet/dotnet/releases)._

No release notes found for this version range.

Commits viewable in [compare
view](https://github.com/dotnet/dotnet/commits).
</details>

Updated
[Microsoft.Extensions.Hosting.Abstractions](https://github.com/dotnet/dotnet)
from 10.0.11 to 10.0.12.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.Extensions.Hosting.Abstractions's
releases](https://github.com/dotnet/dotnet/releases)._

No release notes found for this version range.

Commits viewable in [compare
view](https://github.com/dotnet/dotnet/commits).
</details>

Updated
[Microsoft.Extensions.Logging.Abstractions](https://github.com/dotnet/dotnet)
from 10.0.11 to 10.0.12.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.Extensions.Logging.Abstractions's
releases](https://github.com/dotnet/dotnet/releases)._

No release notes found for this version range.

Commits viewable in [compare
view](https://github.com/dotnet/dotnet/commits).
</details>

Updated [MongoDB.Driver](https://github.com/mongodb/mongo-csharp-driver)
from 3.11.1 to 3.11.2.

<details>
<summary>Release notes</summary>

_Sourced from [MongoDB.Driver's
releases](https://github.com/mongodb/mongo-csharp-driver/releases)._

## 3.11.2

> [!IMPORTANT]
> This is a security patch release. It addresses two CVEs reported
against the driver, along with a small number of related fixes. There
are no public API changes and no application code changes are required
to upgrade. Note that the shape of some queries generated by the LINQ
provider and by GridFS has changed — see the individual tickets below.

This is a patch release that contains fixes and stability improvements:

- [CSHARP-6177](https://jira.mongodb.org/browse/CSHARP-6177) /
[CVE-2026-88026](https://www.cve.org/CVERecord?id=CVE-2026-88026): Query
filter regex injection via unescaped backslash and bracket in LINQ
character-set translation
- [CSHARP-6190](https://jira.mongodb.org/browse/CSHARP-6190) /
[CVE-2026-88025](https://www.cve.org/CVERecord?id=CVE-2026-88025): Use
exact match for file ID in GridFS delete methods
- [CSHARP-6213](https://jira.mongodb.org/browse/CSHARP-6213): Normalize
SRV target host names to lower case during SRV polling

The full list of issues resolved in this release is available at [CSHARP
JIRA
project](https://jira.mongodb.org/issues/?jql=project%20%3D%20CSHARP%20AND%20fixVersion%20%3D%203.11.2%20ORDER%20BY%20key%20ASC).

Documentation on the .NET driver can be found
[here](https://www.mongodb.com/docs/drivers/csharp/v3.11/).

Commits viewable in [compare
view](mongodb/mongo-csharp-driver@v3.11.1...v3.11.2).
</details>

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's major version (unless you unignore this specific
dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this
group update PR and stop Dependabot creating any more for the specific
dependency's minor version (unless you unignore this specific
dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR
and stop Dependabot creating any more for the specific dependency
(unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore
conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will
remove the ignore condition of the specified dependency and ignore
conditions


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant