docs: sync site against recent framework changes#208
Merged
Conversation
Catches the site up with PRs since the last sync (#119): - Adds guides for Notifications (#194), Rate Limiting (#206), Broadcasting (#193), and Identity & Sessions (#187/#188/#185/#198). - Documents signed URLs (#195) in the File Storage guide. - Replaces the "not a durable queue" warning in events.md with the actual Wolverine inbox/outbox story (#192). - Refreshes Button variants in the components reference (#157). - Rewrites docs/missing-cross-cutting-modules.md to mark the now- covered modules done and trim the open backlog. - Sidebar updated; pre-existing `<T>` parse error in soft-delete.md fixed so the build is green.
Deploying simplemodule-website with
|
| Latest commit: |
8ba1ad3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://038be079.simplemodule-website.pages.dev |
| Branch Preview URL: | https://docs-update.simplemodule-website.pages.dev |
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
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
Catches the docs site up with the feature PRs that have shipped since the last sync (#119).
New guides under
/guide/:notifications.md—INotifier, mail/SMS/database channels, inbox API,NotificationSentEvent/NotificationFailedEvent(feat(notifications): add multi-channel notifications module (closes #158) #194).rate-limiting.md— DB-defined policies (RateLimiting_Rules),.RateLimit("...")extension, admin UI,IRateLimitingContracts(fix(ratelimit): apply DB-defined rules at runtime + cover auth endpoints #206).broadcasting.md— moved into the site (was an unsited draft atdocs/broadcasting.md) and wired into the sidebar (feat(broadcasting): SignalR hub + @simplemodule/echo client (closes #169) #193).identity.md— self-service unlock (feat(users): add self-service account unlock via email #187), phone confirmation (feat(identity): phone number confirmation flow (closes #174) #198), active sessions (feat(openiddict): user-facing active sessions page #185), sign-out-everywhere (feat(identity): "sign out everywhere" via security stamp regeneration #188).Updates:
events.md— replaced the "not a durable queue" warning with the actual Wolverine inbox/outbox story (feat(events): durable inbox/outbox via Wolverine EF Core #192).file-storage.md— added a Signed URLs section coveringISignedUrlGeneratorand.RequireSignedUrl(...)(feat(security): add signed URL generator (closes #161) #195).frontend/components.md— corrected Button variant/size list and added a usage example (feat(ui): polish core components with additive variants #157)..vitepress/config.ts— registered the four new pages in the sidebar.soft-delete.md— escaped<T>in a heading that was previously breaking the VitePress build.missing-cross-cutting-modules.md— moved Notifications, Broadcasting, FileStorage, BackgroundJobs, Localization, FeatureFlags, RateLimiting, AuditLog into "Already Covered"; only Caching and Webhooks remain on the backlog.Verification
npm run buildfromdocs/site/is green.RateLimiting_Rulesconfirmed in migrations,IOpenIddictSessionContractssignature matched,IBroadcaster/BroadcastChannels.ForUserconfirmed in framework/Core/Broadcasting, etc.).Test plan
cd docs/site && npm run buildexits 0 locally.npm run devand the cross-links inside them navigate correctly.