Skip to content

Commit 6a8c04b

Browse files
Feature/website v2 (#162)
* Add design spec for RCommon documentation website Captures requirements and architecture decisions for the new Docusaurus 3 documentation site at rcommon.com, forked from Hasura's ddn-docs template. * Fix spec review issues: map ApplicationServices, Stateless, and SMTP - 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 * Add implementation plan for RCommon documentation website 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. * chore: clone Hasura ddn-docs as website/ base * chore: convert website from Yarn to pnpm, strip Hasura deps * chore: strip all Hasura content, components, and assets * feat: configure docusaurus.config.ts for RCommon * feat: configure RCommon sidebar navigation structure * feat: set up RCommon theme, branding, and CNAME * feat: adapt Hasura components for RCommon use - 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 * fix: clean Hasura references from theme overrides - 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 * feat: add NuGetInstall and ProviderComparison components * feat: build marketing landing page with hero, features, and code sections * feat: create docs directory structure with stub pages for all documentation pages * ci: add GitHub Actions workflow for website deployment to GitHub Pages * feat: add local search plugin as Algolia fallback * fix: resolve build issues from initial integration - 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 * docs: write Getting Started section (5 pages) 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. * docs: write Core Concepts section (5 pages) * docs: write Domain-Driven Design section (5 pages) 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. * docs: write CQRS & Mediator section (5 pages) * docs: write Event Handling section (7 pages) * docs: write Persistence section (8 pages) 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. * docs: write Blob Storage section (3 pages) * docs: write Multi-Tenancy section (2 pages) * docs: write Security & Web section (2 pages) * docs: write Serialization section (3 pages) * docs: write Validation section (1 page) * docs: write Messaging section (5 pages) * docs: write State Machines section (2 pages) * docs: write Caching section (3 pages) * docs: write Email section (2 pages) * docs: write Architecture Guides section (3 pages) * docs: write Examples & Recipes section (4 pages) * docs: write Testing section (2 pages) * docs: write API Reference section (3 pages) * docs: snapshot version 1.0 of documentation * feat: use rcommon-logo.png as site logo * fix: restore footer layout, remove test placeholder * feat: add sidebar icons, flatten nav, switch to Hasura-style footer with SVG icons * fix: distinguish navbar and sidebar colors, add navbar border * fix: match Hasura dark theme — same navbar/sidebar color, uppercase labels, content area contrast * feat: use separate logo variants for light/dark modes * fix: remove RCommon text from navbar, logo only * fix: center-align main content area * Created new RCommon website on Github pages --------- Co-authored-by: jasonmwebb-lv <jason.webb@leadventure.com>
1 parent 0b8ccfd commit 6a8c04b

0 file changed

File tree

    0 commit comments

    Comments
     (0)