docs: point the example link at postguard-js, not the archived examples repo - #54
Conversation
…es repo README's "Run the example" linked to encryption4all/postguard-examples/tree/main/pg-dotnet. That repo was folded into postguard-js and archived, so the link resolves to a frozen tree that will never change again — no error, just a copy of the example that stops tracking the SDK. Also carries over the multi-targeting note, since `dotnet run` in that example fails without `-f net10.0` and the old link was where a reader would have gone looking. Found auditing what still fetches from the five archived repos' release and package channels (encryption4all/postguard#312).
|
Thanks for the audit, Ruben! I'm on it — reviewing PR #54 now to confirm the README link swap (postguard-examples → postguard-js/examples/pg-dotnet) and the multi-targeting note are correct and complete before submitting my review. |
There was a problem hiding this comment.
The repoint is right, and the parts that could quietly be wrong check out: encryption4all/postguard-examples really is archived (.archived == true), the new postguard-js/examples/pg-dotnet URL returns 200 and that repo is not archived, and a grep over this HEAD finds no other archived-repo reference left in the repo. .github/pg-ffi-version pins a release from encryption4all/postguard, which is live, so it is not a second hit.
The multi-targeting note earns its place too. The example's csproj really is <TargetFrameworks>net8.0;net10.0</TargetFrameworks>, and a scratch multi-targeted project reproduces the quoted error verbatim under a bare dotnet run, exiting 0 with -f net10.0.
One style comment on the new block, with a suggestion that covers it. Nothing blocking.
| See [`examples/pg-dotnet`](https://github.com/encryption4all/postguard-js/tree/main/examples/pg-dotnet) | ||
| in the postguard-js workspace. It lived in `encryption4all/postguard-examples` | ||
| until that repository was folded in and archived. | ||
|
|
||
| It multi-targets `net8.0;net10.0`, so a bare `dotnet run` fails with "Your project | ||
| targets multiple frameworks" — pass `-f net10.0`. |
There was a problem hiding this comment.
Three small things, all in this block. The suggestion below fixes them together.
Hard wrapping: this is the only wrapped prose in README.md. Every other paragraph is a single unwrapped line, some of them long (336, 265 and 237 characters). Wrapping here means future edits to these sentences reflow the whole block and show up as noise in the diff.
The em dash before "pass -f net10.0": README.md had zero em dashes across its 239 words before this PR, and writing-rules puts the ceiling at one per thousand. A semicolon does the same work here.
"It lived in encryption4all/postguard-examples until that repository was folded in and archived": this is history rather than instruction, and no-justification-paragraphs-for-simple-changes asks for the change without the note about the prior state. Someone reading this README does not have the old link in hand. The reader who does is over on the archived repo, where this sentence cannot reach them. It also leaves "folded in" dangling, since what it was folded into is never named. If you would rather keep the provenance, the minimal fix is "folded into postguard-js and archived".
| See [`examples/pg-dotnet`](https://github.com/encryption4all/postguard-js/tree/main/examples/pg-dotnet) | |
| in the postguard-js workspace. It lived in `encryption4all/postguard-examples` | |
| until that repository was folded in and archived. | |
| It multi-targets `net8.0;net10.0`, so a bare `dotnet run` fails with "Your project | |
| targets multiple frameworks" — pass `-f net10.0`. | |
| See [`examples/pg-dotnet`](https://github.com/encryption4all/postguard-js/tree/main/examples/pg-dotnet) in the postguard-js workspace. | |
| It multi-targets `net8.0;net10.0`, so a bare `dotnet run` fails with "Your project targets multiple frameworks"; pass `-f net10.0`. |
|
Approved: #54 (review) I checked the link repoint and the claims behind it — Left one non-blocking style comment with a one-click suggestion on the new README paragraph: it's the only hard-wrapped line in the file, adds the file's first em dash, and the "folded in and archived" phrasing is a bit dangling — offered "folded into postguard-js" as a minimal fix if you want to keep that provenance detail. |
Found auditing what still fetches from the five archived repos' release and package channels (encryption4all/postguard#312). This repo had exactly one hit.
README's "Run the example" linked to
encryption4all/postguard-examples/tree/main/pg-dotnet. That repository was folded into postguard-js and archived, so the link resolves — 200, no error — to a tree that can never change again. A reader following it gets a copy of the example that has silently stopped tracking the SDK.Now points at
postguard-js/examples/pg-dotnet(verified 200), and carries over the multi-targeting note, sincedotnet runin that example fails with "Your project targets multiple frameworks" without-f net10.0and the old link is where someone would have gone looking for that.Nothing else in this repo references an archived channel:
.github/pg-ffi-versionpins apg-ffirelease fromencryption4all/postguard, which is live and is the crate's real home.