docs: document TUI, password-based encryption, and S3/database VFS backends#22
Merged
Conversation
…S backends - README: add SquidStd.Tui row under new ### User interface section (after Workers) - README: update SquidStd.Vfs row to mention composable decorators (ReadOnlyFileSystem, ScopedFileSystem, OverlayFileSystem, CachingFileSystem) - README: add SquidStd.Vfs.S3 and SquidStd.Vfs.Database rows to Storage section - README: update SquidStd.Crypto row to mention PasswordCipher and Argon2id + AES-256-GCM - README: extend Overview bullet for Data & storage to mention new VFS backends/decorators; add new Terminal UI bullet for SquidStd.Tui - docs/articles: add tui.md, vfs-s3.md, vfs-database.md include articles - docs/articles/toc.yml: add SquidStd.Vfs.S3, SquidStd.Vfs.Database after SquidStd.Vfs; add SquidStd.Tui before SquidStd.Crypto - docs/tutorials/tui.md: new tutorial covering CounterViewModel, imperative TuiView<T>, declarative TuiComposedView<T> DSL, DI boot, and ViewModel-first navigation - docs/tutorials/vfs.md: add S3 and database backend sections; add CachingFileSystem, ReadOnlyFileSystem, ScopedFileSystem, and OverlayFileSystem decorator examples - docs/tutorials/crypto.md: add password-based encryption section (PasswordCipher.Encrypt/ Decrypt, EncryptString/DecryptString, PbkdfCost.Sensitive, PasswordDecryptionException) - docs/tutorials/toc.yml: add Terminal UI (MVVM) entry
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings the site-level documentation in line with features merged this cycle (the per-module READMEs were already current; this updates the root index, the DocFX articles, and the tutorials).
Root README — Packages table
SquidStd.Tui(was entirely absent).SquidStd.Vfs.S3andSquidStd.Vfs.Databaserows.SquidStd.Vfs(now mentions the read-only/scoped/overlay/caching decorators) andSquidStd.Crypto(now mentionsPasswordCipher/ Argon2id + AES-256-GCM) descriptions.DocFX articles
tui.md,vfs-s3.md,vfs-database.md(reference-include of their READMEs) +articles/toc.ymlentries. (crypto.md/vfs.mdarticles already reflect the updates via the include pattern.)DocFX tutorials
TuiView<T>+ declarativeTuiComposedView<T>DSL, DI boot, navigation).Notes
src/**/README.mdordocs/api/**changes.docfx buildran clean (0 errors; the 4 warnings are pre-existing — relative cross-links in source READMEs + the known api/toc.yml note).Test plan
docfx build docs/docfx.json— 0 errors