Skip to content

Commit e357df7

Browse files
committed
docs: link tutorials and concepts from the new-module READMEs
1 parent f767a42 commit e357df7

6 files changed

Lines changed: 25 additions & 0 deletions

File tree

src/SquidStd.Actors/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ using var sub = session.SubscribeToEventBus(eventBus, (UserJoinedEvent e) => new
7979

8080
`DisposeAsync` completes the mailbox, drains in-flight work, and faults any still-pending requests.
8181

82+
## Related
83+
84+
- Tutorial: [Actors](https://tgiachi.github.io/squid-std/tutorials/actors.html)
85+
- Concept: [Messaging models](https://tgiachi.github.io/squid-std/articles/concepts/messaging-models.html)
86+
8287
## License
8388

8489
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Crypto/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,10 @@ var folderVault = new CryptoFileSystem(new PhysicalFileSystem("/secure/dir"));
122122
- A wrong passphrase fails the index authentication tag → `CryptographicException`; operations on a locked
123123
vault throw `InvalidOperationException`.
124124

125+
## Related
126+
127+
- Tutorial: [Crypto (PGP)](https://tgiachi.github.io/squid-std/tutorials/crypto.html)
128+
125129
## License
126130

127131
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Persistence/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ container.ApplyPersistedEntityRegistrations(); // builds descriptors into IPer
6666
| `SnapshotService` | Atomic per-type binary snapshot files with payload checksum. |
6767
| `RegisterPersistedEntity<T,TKey>()` | DI helper recording an entity for descriptor construction. |
6868

69+
## Related
70+
71+
- Tutorial: [Persistence](https://tgiachi.github.io/squid-std/tutorials/persistence.html)
72+
6973
## License
7074

7175
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Secrets.Aws/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ await foreach (var name in store.ListNamesAsync("db/")) { /* ... */ }
6868
- **Tested against LocalStack** — the KMS and Secrets Manager adapters are covered by integration tests
6969
running on a `localstack/localstack` container.
7070

71+
## Related
72+
73+
- Tutorial: [Secrets (KMS / Secrets Manager)](https://tgiachi.github.io/squid-std/tutorials/secrets.html)
74+
7175
## License
7276

7377
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Vfs.Abstractions/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ dotnet add package SquidStd.Vfs.Abstractions
1717
| `VfsPath` | Static helper that normalizes logical paths to forward-slash, root-relative form and rejects `.`/`..` traversal segments. |
1818
| `VfsEntry` | Record describing a listed entry: its logical path, byte size and last-modified UTC timestamp. |
1919

20+
## Related
21+
22+
- Tutorial: [Virtual filesystem](https://tgiachi.github.io/squid-std/tutorials/vfs.html)
23+
2024
## License
2125

2226
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

src/SquidStd.Vfs/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@ Logical paths are normalized (forward slashes, root-relative) and reject `..` tr
6060
| `VfsDirectories` | Named directory layout (`DirectoriesConfig` analogue) over any backend. |
6161
| `RegisterVfsExtensions` | `RegisterVfs(...)` registration. |
6262

63+
## Related
64+
65+
- Tutorial: [Virtual filesystem](https://tgiachi.github.io/squid-std/tutorials/vfs.html)
66+
6367
## License
6468

6569
MIT — part of [SquidStd](https://github.com/tgiachi/squid-std).

0 commit comments

Comments
 (0)