Skip to content

Commit 7827bf9

Browse files
Docs: the banner in the README, ODX site name, and an accuracy pass for the final release (#103)
* Docs: the banner in the README, and an accuracy pass for the final release The root README shows the Core banner under its title, as the package READMEs do. Getting started shows the MSSqlClient banner under "With SQL Server". The README, the five package READMEs and every article were checked against master: no other factual error was found. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> * Docs: ODX site name, logo spacing, and the tagline only in the banner alt text The site name and the root README title read Open.Database.Extensions (ODX). The landing page has no H1; its front matter title is the browser-tab title. Space between the logo and the site name in the header. The tagline is no longer repeated as text next to a banner (README, landing page, Core README). CONTRIBUTING-DOCS says so. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent d57769b commit 7827bf9

7 files changed

Lines changed: 12 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Open.Database.Extensions
1+
# Open.Database.Extensions (ODX)
2+
3+
![Open.Database.Extensions: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-core.svg)
24

35
[![NuGet](https://img.shields.io/nuget/vpre/Open.Database.Extensions.Core.svg?style=flat)](https://www.nuget.org/packages/Open.Database.Extensions.Core/)
46
[![Docs](https://github.com/Open-NET-Libraries/Open.Database.Extensions/actions/workflows/docs.yml/badge.svg)](https://github.com/Open-NET-Libraries/Open.Database.Extensions/actions/workflows/docs.yml)
57
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Open-NET-Libraries/Open.Database.Extensions/blob/master/LICENSE)
68

7-
**You write the SQL. This library writes the other twenty lines.**
8-
99
Open.Database.Extensions replaces the ADO.NET code around your own SQL with one fluent command: create the connection, add the parameters, run it, map the rows, dispose everything, the way ADO.NET best practice says. It works with any ADO.NET provider and the ADO.NET types you already use, holds a connection open as briefly as it can, and allocates little.
1010

1111
**[Documentation](https://open-net-libraries.github.io/Open.Database.Extensions/)** · [Getting started](https://open-net-libraries.github.io/Open.Database.Extensions/articles/getting-started.html) · [API reference](https://open-net-libraries.github.io/Open.Database.Extensions/api/index.html) · [Benchmarks](https://github.com/Open-NET-Libraries/Open.Database.Extensions/blob/master/Benchmarks/RESULTS.md)

‎Source/Core/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
![Open.Database.Extensions.Core: You write the SQL. The library writes the other twenty lines.](https://raw.githubusercontent.com/Open-NET-Libraries/Open.Database.Extensions/master/docsite/images/hero-core.svg)
44

5-
**You write the SQL. This library writes the other twenty lines.**
6-
75
Core is the foundation of Open.Database.Extensions: ADO.NET extension methods with best-practice defaults, expressive commands that open, run and dispose their own connection, and `Map<T>()` to turn rows into objects. It has no database dependency of its own. **Use it for any ADO.NET database;** most applications need only this package.
86

97
```sh

‎docsite/CONTRIBUTING-DOCS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ Every push to `master` rebuilds and publishes the site (`.github/workflows/docs.
1010
- **Side-by-side comparisons:** wrap two markdown code blocks in `<div class="side-by-side">` (one `<div>` per column, blank lines around the content, styled by `templates/custom/public/main.css`). Both regions need the same number of lines so the rows align.
1111
- **README.md:** a pitch with absolute links; its code blocks are copied from sample regions.
1212
- **Package READMEs:** each `Source/<Project>/README.md` is the page nuget.org shows for that package (`Source/Directory.Build.props` packs the one beside the `.csproj`). Absolute links only, code blocks copied from sample regions. The "The packages" table is the same in every one of them: change it in all of them together.
13-
- **Package heroes:** the banner directly under the H1 of each package README is `docsite/images/hero-<package>.svg` (1280 by 200; Core is 260). Left column: the ODX mark (a database and the letters ODX, in the package's accent color) with the package name; then the tagline; then a small scene. ODX is the acronym and the mark, not the name: the H1 and the prose keep saying Open.Database.Extensions. Each is linked by its absolute `raw.githubusercontent.com` URL because nuget.org shows only images from allow-listed hosts (that host is one). Each paints its own soft background in a light and a dark palette (`prefers-color-scheme`), because nuget.org's page theme can differ from the operating system's; keep the contrast soft and any motion subtle (`prefers-reduced-motion` turns it off).
13+
- **Package heroes:** the banner directly under the H1 of each package README is `docsite/images/hero-<package>.svg` (1280 by 200; Core is 260). Left column: the ODX mark (a database and the letters ODX, in the package's accent color) with the package name; then the tagline; then a small scene. ODX is the acronym and the mark, not the name. The site name (`_appName` and `_appTitle` in `docfx.json`) and the H1 of the root `README.md` say "Open.Database.Extensions (ODX)"; the landing page `docsite/index.md` has no H1, by design (the header shows the name and the banner says what the library is, with its alt text as the accessible name; its front matter `title` is the browser-tab title); the package README H1s and all prose keep the full name Open.Database.Extensions. The banner's alt text carries the tagline; never repeat the tagline as text next to a banner. Each is linked by its absolute `raw.githubusercontent.com` URL because nuget.org shows only images from allow-listed hosts (that host is one). Each paints its own soft background in a light and a dark palette (`prefers-color-scheme`), because nuget.org's page theme can differ from the operating system's; keep the contrast soft and any motion subtle (`prefers-reduced-motion` turns it off).
1414
- **Build locally:** `dotnet tool restore`, then `dotnet docfx docsite/docfx.json --serve`.
1515
- **Failures:** warnings are listed in the workflow summary and never block a deploy. A DocFX error or a sample that does not compile does, and the live site stays as it was.

‎docsite/articles/getting-started.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ What is different:
9191

9292
## With SQL Server
9393

94+
![Open.Database.Extensions.MSSqlClient: You write the SQL. The library writes the other twenty lines.](../images/hero-mssqlclient.svg)
95+
9496
`Open.Database.Extensions.MSSqlClient` provides `SqlConnectionFactory`. Everything above works the same way, and stored procedures are one call away:
9597

9698
[!code-csharp[](../samples/SqlServer.cs#sql_server_factory)]

‎docsite/docfx.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@
5353
"output": "_site",
5454
"template": [ "default", "modern", "templates/custom" ],
5555
"globalMetadata": {
56-
"_appName": "Open.Database.Extensions",
57-
"_appTitle": "Open.Database.Extensions",
56+
"_appName": "Open.Database.Extensions (ODX)",
57+
"_appTitle": "Open.Database.Extensions (ODX)",
5858
"_appFooter": "<span>Open.Database.Extensions &middot; MIT license &middot; built from <code>master</code> by GitHub Actions</span>",
5959
"_appLogoPath": "images/logo.png",
6060
"_appFaviconPath": "images/favicon.png",

‎docsite/index.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
11
---
2-
title: Open.Database.Extensions
2+
title: Open.Database.Extensions (ODX)
33
---
44

5-
# Open.Database.Extensions
6-
75
![Open.Database.Extensions: You write the SQL. The library writes the other twenty lines.](images/hero-core.svg)
86

97
Extensions on the standard ADO.NET types that make everyday database work short to write and robust by default. Version 11 is a release candidate.
108

11-
**You write the SQL. This library writes the other twenty lines.**
12-
139
[!code-csharp[](samples/BeforeAfter.cs#ode_list_factory)]
1410

1511
Here `author` is an `int` variable: the parameter name `author` comes from the argument.

‎docsite/templates/custom/public/main.css‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,6 @@
1919
@media (max-width: 767.98px) {
2020
.side-by-side { grid-template-columns: minmax(0, 1fr); }
2121
.side-by-side > div + div { margin-top: 1rem; }
22-
}
22+
}
23+
/* Space between the logo and the site name in the header brand (the logo img butts against the text otherwise). */
24+
.navbar-brand #logo { margin-inline-end: 0.5em; }

0 commit comments

Comments
 (0)