Skip to content

README images link to the docs, not to the image file - #115

Merged
electricessence merged 1 commit into
masterfrom
docs/banner-links
Nov 10, 2026
Merged

electricessence merged 1 commit into
masterfrom
docs/banner-links

Conversation

@electricessence

Copy link
Copy Markdown
Collaborator

What changes

On GitHub, an image that is not inside a link is wrapped in a link to the image file itself, so clicking a README banner opened the raw SVG. Each README image is now inside a link that goes somewhere useful:

  • the hero banner at the top of the root README and of the five package READMEs (Channel, Core, Dataflow, MSSqlClient, SqlClient) links to the documentation home page;
  • the "How it fits together" diagram in the root README links to the Foundation article, which explains the layers.

Markdown only, so the package READMEs still render on NuGet, where the banner now links to the docs too.

Checks

  • GitHub's markdown API (gh api markdown, mode gfm) renders each image directly inside the new link, with no added link to the image file.
  • Both link targets return HTTP 200.
  • Text only: no code, build or DocFX run.

🤖 Generated with Claude Code

@electricessence
electricessence merged commit 250d2c1 into master Nov 10, 2026
2 checks passed
@electricessence
electricessence deleted the docs/banner-links branch November 10, 2026 22:54
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