Feature/website v2#161
Merged
JasonMWebb merged 46 commits intomainfrom Mar 24, 2026
Merged
Conversation
Captures requirements and architecture decisions for the new Docusaurus 3 documentation site at rcommon.com, forked from Hasura's ddn-docs template.
- Place RCommon.ApplicationServices under CQRS & Mediator > Command & Query Bus - Add State Machines section for RCommon.Stateless integration - Clarify SMTP is built into RCommon.Emailing, not a separate package
35-task plan covering site infrastructure (fork Hasura ddn-docs, strip/adapt, components, landing page, deployment) and comprehensive content generation for all 37+ packages organized across 19 documentation sections.
- OverviewIconCard: added generic icon/title/description/link props, kept iconName for backward compat - OverviewTopSection: made youtubeVideoId optional, video block only renders when provided - OverviewPlainCard: removed missing chevron-right.svg icon, replaced with HTML entity - CustomFooter: replaced Hasura links/copyright/localStorage with RCommon GitHub and NuGet links - Feedback: removed Hasura-specific customFields (docsServerURL, hasuraVersion, DEV_TOKEN), replaced with no-op submit, updated GitHub issue link to RCommon repo, fixed JSX attribute casing - Thumbnail: removed react-transition-group dependency (not installed), replaced CSSTransition with simple conditional render
- DocItem/Layout: removed HasuraBanner and CanonicalUrl imports (components deleted), kept CustomFooter - DocRoot/Layout: removed AiChatBot, OpenReplay, posthog analytics; simplified to structural layout only - DocRoot/Layout/FetchUser: replaced Hasura GraphQL user-fetch with no-op stub - DocRoot/Layout/Main: removed DDN-specific login_button URL manipulation logic - Navbar/Content: removed AiChatBot, CopyLLM, and Hasura console login button - Navbar/MobileSidebar/Header: removed missing docs-logo-light.svg import - Navbar/MobileSidebar/PrimaryMenu: removed Hasura cloud login link - DocSidebarItem/utils: replaced missing Hasura SVG icon imports with no-op label renderer - AnnouncementBar: removed missing x-close.svg icon imports, replaced with HTML entity close button - pages/index.tsx: replaced Hasura homepage content with generic RCommon placeholder
- Add @docusaurus/theme-common as direct dependency (required by swizzled theme components) - Replace invalid 'xml' Prism language with 'markup' (xml is not a standalone Prism language) - Add generated-index links to sidebar sub-categories (Providers, Persistence Caching) to prevent broken SSR fallback hrefs - Fix homepage and footer links pointing to non-existent category root paths; update to use /docs/category/* and specific doc paths
Replaced stubs in website/docs/getting-started/ with complete documentation covering the overview and philosophy, installation (all NuGet packages by category), a quick-start walkthrough with EF Core, full configuration and bootstrapping reference, and a dependency injection guide explaining service lifetimes and injection patterns. All content is based on reading the actual source code.
Replace all five stub pages under website/docs/domain-driven-design/ with full documentation sourced from actual source code in RCommon.Entities and RCommon.Core/EventHandling. Each page covers the real class and interface hierarchy, working C# examples, and an API summary table.
Replaces all 8 stubs under website/docs/persistence/ with comprehensive documentation sourced directly from the production C# interfaces and concrete implementations. Each page covers overview, installation, configuration, usage with code examples, and an API summary table.
…abels, content area contrast
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
2 participants
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.
Created a new website for RCommon that is substantially better with documentation.