From 4401b4fe4242615fd4b9213ea45e8e1c9b8f69a1 Mon Sep 17 00:00:00 2001 From: Volker Christian Date: Wed, 14 Oct 2026 15:38:08 +0200 Subject: [PATCH] docs: fix review findings and SNode.C display names --- README.md | 4 ++-- docs/README.md | 2 +- docs/maintainers.md | 4 ++-- docs/media/banner.svg | 2 +- docs/media/hero-mobile.svg | 2 +- docs/media/nav/organization-dark.svg | 2 +- docs/media/nav/organization-icon-dark.svg | 2 +- docs/media/nav/organization-icon-light.svg | 2 +- docs/media/nav/organization-light.svg | 2 +- docs/setup.md | 2 +- site/README.md | 6 +++--- site/docs/README.md | 2 +- site/docs/catalogs/README.md | 2 +- site/docs/catalogs/mqttsuite.md | 2 +- site/docs/catalogs/snodec.md | 2 +- site/docs/installation/README.md | 2 +- site/docs/installation/debian.md | 2 +- site/docs/installation/fedora.md | 2 +- site/docs/installation/openwrt.md | 2 +- site/docs/installation/package-selection.md | 2 +- site/docs/installation/raspberry-pi-os.md | 2 +- site/docs/installation/rocky-linux.md | 2 +- site/docs/installation/ubuntu.md | 2 +- site/docs/media/banner.svg | 2 +- site/docs/media/hero-mobile.svg | 2 +- site/docs/media/nav/organization-dark.svg | 2 +- site/docs/media/nav/organization-icon-dark.svg | 2 +- site/docs/media/nav/organization-icon-light.svg | 2 +- site/docs/media/nav/organization-light.svg | 2 +- site/docs/publication.md | 2 +- site/docs/troubleshooting.md | 2 +- site/keys/README.md | 2 +- tests/test_packaging.py | 2 +- 33 files changed, 37 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index ae19114..0a91202 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,12 @@

DistributionPackages — Package tooling and publication.

-

SNodeC organization

+

SNode.C organization

# DistributionPackages -Build recipes, authenticated handoffs, signing and publication for SNodeC distribution packages. This is the maintainer control repository; [Packages](https://github.com/SNodeC/Packages#project-overview) is the public installation and availability hub. +Build recipes, authenticated handoffs, signing and publication for SNode.C distribution packages. This is the maintainer control repository; [Packages](https://github.com/SNodeC/Packages#project-overview) is the public installation and availability hub. ## Operations diff --git a/docs/README.md b/docs/README.md index bacf8cb..1cfae66 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@

DistributionPackages — Documentation

-

Up to Dist. PackagesSNodeC organizationDistributionPackages repository

+

Up to Dist. PackagesSNode.C organizationDistributionPackages repository

# DistributionPackages documentation diff --git a/docs/maintainers.md b/docs/maintainers.md index 0e917f0..6493874 100644 --- a/docs/maintainers.md +++ b/docs/maintainers.md @@ -1,7 +1,7 @@

DistributionPackages — Documentation

-

Up to DocumentationSNodeC organizationDistributionPackages repository

+

Up to DocumentationSNode.C organizationDistributionPackages repository

# Repository maintenance @@ -61,7 +61,7 @@ Superseded files remain for 30 days after leaving the active index. Cleanup runs | [MQTTSuite build-distribution-packages.yml](https://github.com/SNodeC/mqttsuite/blob/master/.github/workflows/build-distribution-packages.yml) | Same lifecycle, using the corresponding published SNode.C dependency | | [sign-and-publish-packages.yml](https://github.com/SNodeC/DistributionPackages/blob/main/.github/workflows/sign-and-publish-packages.yml) | Validate completed upstream artifacts, sign, publish and dispatch dependent targets | -The manual-only **Render package status** workflow in DistributionPackages runs the default-branch renderer against the current Packages state, with the existing publication concurrency group and metadata retry transaction. It does not build, sign or publish packages, and is not triggered automatically after merge. Run it only after explicit approval. Locally: `python3 -m ci.publish.publication render /path/to/Packages`. The local renderer preserves authored documentation, feed records and `status.json`. The approved manual workflow also hands off the current `site/` README, documentation and keys guide through the same metadata retry transaction; it removes obsolete documentation without changing key bytes or installer behavior. +The manual-only **Publish package guides and render status** workflow in DistributionPackages runs the default-branch renderer against the current Packages state, with the existing publication concurrency group and metadata retry transaction. It does not build, sign or publish packages, and is not triggered automatically after merge. Run it only after explicit approval. Locally: `python3 -m ci.publish.publication render /path/to/Packages`. The local renderer preserves authored documentation, feed records and `status.json`. The approved manual workflow also hands off the current `site/` README, documentation and keys guide through the same metadata retry transaction; it removes obsolete documentation without changing key bytes or installer behavior. SNode.C and MQTTSuite package workflows also support a manual fresh start: choose **Run workflow** on the source repository’s default branch and supply an existing `vMAJOR.MINOR.PATCH` tag as `release_tag`. This allocates a new package revision and captures that tag with current DistributionPackages tooling; no tag is created, moved or deleted. Publication authenticates the manual run’s repository, workflow, default branch, capture identity, attempt and target job. Tag/Version validation remains in the existing capture path. A job retry retains the original capture and requires its artifact; a new manual start is the recovery route when a full rerun loses that artifact. diff --git a/docs/media/banner.svg b/docs/media/banner.svg index 90f27d3..0a572ce 100644 --- a/docs/media/banner.svg +++ b/docs/media/banner.svg @@ -1 +1 @@ -DistributionPackagesPackage tooling and publication. Build recipes · Authenticated handoffs · Signing · PublicationSNODEC · INFRASTRUCTURE · MAINTAINERSDistributionPackagesPackage tooling and publication.Build recipes · Authenticated handoffs · Signing · Publication +DistributionPackagesPackage tooling and publication. Build recipes · Authenticated handoffs · Signing · PublicationSNODE.C · INFRASTRUCTURE · MAINTAINERSDistributionPackagesPackage tooling and publication.Build recipes · Authenticated handoffs · Signing · Publication diff --git a/docs/media/hero-mobile.svg b/docs/media/hero-mobile.svg index 5f2dcf5..e9a9ce6 100644 --- a/docs/media/hero-mobile.svg +++ b/docs/media/hero-mobile.svg @@ -1 +1 @@ -DistributionPackagesPackage tooling and publication. Build recipes · Authenticated handoffs · Signing · PublicationSNODEC · INFRASTRUCTURE · MAINTAINERSDistributionPackagesPackage tooling and publication.Build recipes · Authenticated handoffsSigning · Publication +DistributionPackagesPackage tooling and publication. Build recipes · Authenticated handoffs · Signing · PublicationSNODE.C · INFRASTRUCTURE · MAINTAINERSDistributionPackagesPackage tooling and publication.Build recipes · Authenticated handoffsSigning · Publication diff --git a/docs/media/nav/organization-dark.svg b/docs/media/nav/organization-dark.svg index a63a53c..b7f440f 100644 --- a/docs/media/nav/organization-dark.svg +++ b/docs/media/nav/organization-dark.svg @@ -1,4 +1,4 @@ -SNodeC organization

DistributionPackages — Documentation

-

Up to DocumentationSNodeC organizationDistributionPackages repository

+

Up to DocumentationSNode.C organizationDistributionPackages repository

# CI setup and activation diff --git a/site/README.md b/site/README.md index 47ea2e8..4df4d7e 100644 --- a/site/README.md +++ b/site/README.md @@ -4,10 +4,10 @@

Packages — Signed packages for the SNode.C ecosystem.

-

SNodeC organization

+

SNode.C organization

-# SNodeC Packages +# SNode.C Packages Signed packages for the SNode.C ecosystem. Choose a project and distribution, install using its signed package source, and inspect availability separately from ongoing builds. @@ -67,6 +67,6 @@ Report installation issues in [Packages](https://github.com/SNodeC/Packages/issu ## Ecosystem -[SNodeC organization](https://github.com/SNodeC) · [SNode.C](https://github.com/SNodeC/snode.c#project-overview) · [MQTTSuite](https://github.com/SNodeC/mqttsuite#project-overview) +[SNode.C organization](https://github.com/SNodeC) · [SNode.C](https://github.com/SNodeC/snode.c#project-overview) · [MQTTSuite](https://github.com/SNodeC/mqttsuite#project-overview) [Contributing](https://github.com/SNodeC/.github/blob/HEAD/CONTRIBUTING.md) · [Security](https://github.com/SNodeC/.github/blob/HEAD/SECURITY.md) diff --git a/site/docs/README.md b/site/docs/README.md index a3c6f24..5c36936 100644 --- a/site/docs/README.md +++ b/site/docs/README.md @@ -1,7 +1,7 @@

Packages — Documentation

-

Up to PackagesSNodeC organizationPackages repository

+

Up to PackagesSNode.C organizationPackages repository

# Documentation diff --git a/site/docs/catalogs/README.md b/site/docs/catalogs/README.md index 69fd002..2158d26 100644 --- a/site/docs/catalogs/README.md +++ b/site/docs/catalogs/README.md @@ -1,7 +1,7 @@

Packages — Catalogs

-

Up to DocumentationSNodeC organizationPackages repository

+

Up to DocumentationSNode.C organizationPackages repository

# Catalogs diff --git a/site/docs/catalogs/mqttsuite.md b/site/docs/catalogs/mqttsuite.md index 02cf619..2a1fff6 100644 --- a/site/docs/catalogs/mqttsuite.md +++ b/site/docs/catalogs/mqttsuite.md @@ -3,7 +3,7 @@

Packages — Catalogs

-

Up to CatalogsSNodeC organizationPackages repository

+

Up to CatalogsSNode.C organizationPackages repository

# MQTTSuite package catalog diff --git a/site/docs/catalogs/snodec.md b/site/docs/catalogs/snodec.md index 02e2493..52f6cdf 100644 --- a/site/docs/catalogs/snodec.md +++ b/site/docs/catalogs/snodec.md @@ -3,7 +3,7 @@

Packages — Catalogs

-

Up to CatalogsSNodeC organizationPackages repository

+

Up to CatalogsSNode.C organizationPackages repository

# SNode.C package catalog diff --git a/site/docs/installation/README.md b/site/docs/installation/README.md index b21ce59..8a4f280 100644 --- a/site/docs/installation/README.md +++ b/site/docs/installation/README.md @@ -1,7 +1,7 @@

Packages — Installation

-

Up to DocumentationSNodeC organizationPackages repository

+

Up to DocumentationSNode.C organizationPackages repository

# Installation diff --git a/site/docs/installation/debian.md b/site/docs/installation/debian.md index 1c609a3..649d67c 100644 --- a/site/docs/installation/debian.md +++ b/site/docs/installation/debian.md @@ -3,7 +3,7 @@

Packages — Installation

-

Up to InstallationSNodeC organizationPackages repository

+

Up to InstallationSNode.C organizationPackages repository

# Debian diff --git a/site/docs/installation/fedora.md b/site/docs/installation/fedora.md index ebae789..5d18b84 100644 --- a/site/docs/installation/fedora.md +++ b/site/docs/installation/fedora.md @@ -3,7 +3,7 @@

Packages — Installation

-

Up to InstallationSNodeC organizationPackages repository

+

Up to InstallationSNode.C organizationPackages repository

# Fedora diff --git a/site/docs/installation/openwrt.md b/site/docs/installation/openwrt.md index 9042a37..a788780 100644 --- a/site/docs/installation/openwrt.md +++ b/site/docs/installation/openwrt.md @@ -3,7 +3,7 @@

Packages — Installation

-

Up to InstallationSNodeC organizationPackages repository

+

Up to InstallationSNode.C organizationPackages repository

# OpenWrt diff --git a/site/docs/installation/package-selection.md b/site/docs/installation/package-selection.md index c80f1be..ed78d3f 100644 --- a/site/docs/installation/package-selection.md +++ b/site/docs/installation/package-selection.md @@ -6,7 +6,7 @@

Packages — Installation

-

Up to InstallationSNodeC organizationPackages repository

+

Up to InstallationSNode.C organizationPackages repository

# DEB and RPM package selection diff --git a/site/docs/installation/raspberry-pi-os.md b/site/docs/installation/raspberry-pi-os.md index 79e1cbd..eaa1122 100644 --- a/site/docs/installation/raspberry-pi-os.md +++ b/site/docs/installation/raspberry-pi-os.md @@ -3,7 +3,7 @@

Packages — Installation

-

Up to InstallationSNodeC organizationPackages repository

+

Up to InstallationSNode.C organizationPackages repository

# Raspberry Pi OS diff --git a/site/docs/installation/rocky-linux.md b/site/docs/installation/rocky-linux.md index e12468f..3cba212 100644 --- a/site/docs/installation/rocky-linux.md +++ b/site/docs/installation/rocky-linux.md @@ -3,7 +3,7 @@

Packages — Installation

-

Up to InstallationSNodeC organizationPackages repository

+

Up to InstallationSNode.C organizationPackages repository

# Rocky Linux diff --git a/site/docs/installation/ubuntu.md b/site/docs/installation/ubuntu.md index 3c177b7..f9c63df 100644 --- a/site/docs/installation/ubuntu.md +++ b/site/docs/installation/ubuntu.md @@ -3,7 +3,7 @@

Packages — Installation

-

Up to InstallationSNodeC organizationPackages repository

+

Up to InstallationSNode.C organizationPackages repository

# Ubuntu diff --git a/site/docs/media/banner.svg b/site/docs/media/banner.svg index 72c3c1a..a534e5e 100644 --- a/site/docs/media/banner.svg +++ b/site/docs/media/banner.svg @@ -1 +1 @@ -PackagesSigned packages for the SNode.C ecosystem. OpenWrt · Raspberry Pi OS · Debian · Ubuntu · Rocky Linux · FedoraSNODEC · INFRASTRUCTUREPackagesSigned packages for the SNode.C ecosystem.OpenWrt · Raspberry Pi OS · Debian · Ubuntu · Rocky Linux · Fedora +PackagesSigned packages for the SNode.C ecosystem. OpenWrt · Raspberry Pi OS · Debian · Ubuntu · Rocky Linux · FedoraSNODE.C · INFRASTRUCTUREPackagesSigned packages for the SNode.C ecosystem.OpenWrt · Raspberry Pi OS · Debian · Ubuntu · Rocky Linux · Fedora diff --git a/site/docs/media/hero-mobile.svg b/site/docs/media/hero-mobile.svg index 6a22e77..d96a192 100644 --- a/site/docs/media/hero-mobile.svg +++ b/site/docs/media/hero-mobile.svg @@ -1 +1 @@ -PackagesSigned packages for the SNode.C ecosystem. OpenWrt · Raspberry Pi OS · Debian · Ubuntu · Rocky Linux · FedoraSNODEC · INFRASTRUCTUREPackagesSigned packages for the SNode.C ecosystem.OpenWrt · Raspberry Pi OS · DebianUbuntu · Rocky Linux · Fedora +PackagesSigned packages for the SNode.C ecosystem. OpenWrt · Raspberry Pi OS · Debian · Ubuntu · Rocky Linux · FedoraSNODE.C · INFRASTRUCTUREPackagesSigned packages for the SNode.C ecosystem.OpenWrt · Raspberry Pi OS · DebianUbuntu · Rocky Linux · Fedora diff --git a/site/docs/media/nav/organization-dark.svg b/site/docs/media/nav/organization-dark.svg index a63a53c..b7f440f 100644 --- a/site/docs/media/nav/organization-dark.svg +++ b/site/docs/media/nav/organization-dark.svg @@ -1,4 +1,4 @@ -SNodeC organization

Packages — Documentation

-

Up to DocumentationSNodeC organizationPackages repository

+

Up to DocumentationSNode.C organizationPackages repository

# How publication works diff --git a/site/docs/troubleshooting.md b/site/docs/troubleshooting.md index baf39c7..fc2558e 100644 --- a/site/docs/troubleshooting.md +++ b/site/docs/troubleshooting.md @@ -3,7 +3,7 @@

Packages — Documentation

-

Up to DocumentationSNodeC organizationPackages repository

+

Up to DocumentationSNode.C organizationPackages repository

# Troubleshooting diff --git a/site/keys/README.md b/site/keys/README.md index df2efa7..a82256f 100644 --- a/site/keys/README.md +++ b/site/keys/README.md @@ -3,7 +3,7 @@

Packages — Signing keys

-

Up to PackagesSNodeC organizationPackages repository

+

Up to PackagesSNode.C organizationPackages repository

# Package signing keys diff --git a/tests/test_packaging.py b/tests/test_packaging.py index e9577c8..442763d 100644 --- a/tests/test_packaging.py +++ b/tests/test_packaging.py @@ -598,7 +598,7 @@ def publish(*args): self.assertEqual(publication.read(self.seed/'status.json')['targets'][self.rows[0]['id']+'/snode.c']['status'],'published') for name,data in original.items(): self.assertEqual((self.bundle/name).read_bytes(),data) - self.assertIn('# SNodeC Packages', (self.seed/'README.md').read_text()) + self.assertIn('# SNode.C Packages', (self.seed/'README.md').read_text()) self.assertIn('', (self.seed/'README.md').read_text()) self.assertNotIn('# DistributionPackages', (self.seed/'README.md').read_text()) self.assertEqual((self.seed/'install/install.sh').read_bytes(),(repository.ROOT/'install/install.sh').read_bytes())