Documentation Improvements in landing page

docs/index.md

@@ -1,34 +1,35 @@
----
-hide:
-  - toc
-  - navigation
----
+![Protean](./assets/full-logo.png){ width="400" }
+# Pragmatic Framework for Ambitious Applications
 
-# Protean
-
-Protean is a DDD and CQRS-based framework that helps you build Event-driven applications.
-
-[![Release](https://img.shields.io/pypi/v/protean?label=Release&style=flat-square)](https://pypi.org/project/protean/)
+[![Python](https://img.shields.io/pypi/pyversions/protean?label=Python)](https://github.com/proteanhq/protean/)
+[![Release](https://img.shields.io/pypi/v/protean?label=Release)](https://pypi.org/project/protean/)
 [![Build Status](https://github.com/proteanhq/protean/actions/workflows/ci.yml/badge.svg)](https://github.com/proteanhq/protean/actions/workflows/ci.yml)
 [![Coverage](https://codecov.io/gh/proteanhq/protean/graph/badge.svg?token=0sFuFdLBOx)](https://codecov.io/gh/proteanhq/protean)
 
 ## Overview
 
-**Protean helps you build applications architected for change.**
+**Protean helps you build applications architected for *change* and *growth*.**
+
+Protean is an open-source python framework designed to build ambitious
+applications that scale and evolve with your business.
+
+Protean offers the tools and patterns necessary for creating sustainable,
+domain-driven codebases, utilizing CQRS and Event-Sourcing to tackle complexity
+in high-stakes domains.
 
 At its core, Protean adopts a Domain-Driven Design (DDD) approach to
 development, with support for patterns to succinctly and precisely express
 your domain without worrying about technology aspects. When you are ready,
 you can seamlessly plugin technologies like databases, message brokers, and
 caches, and Protean will take care of the rest.
 
-Protean is loosely based on these three paradigms:
+Protean is loosely based on three paradigms:
 
-- ***Service-Oriented*** - Develop your application as one or more subdomains that
-can run independently as Microservices
-- ***Event-Driven***: - Use events to propagate changes across aggregates and
+- **Service-Oriented**: Develop your application as one or more subdomains
+that can run independently as Microservices
+- **Event-Driven**: Use events to propagate changes across aggregates and
 subdomains to sync state within and across Bounded Contexts.
-- ***Adapter-Based***: - A configuration-driven approach to specify technology
+- **Adapter-Based**: A configuration-driven approach to specify technology
 adapters, with multiple adapters supported out of the box.
 
 ## Features
@@ -39,31 +40,43 @@ adapters, with multiple adapters supported out of the box.
 
     ---
 
-    Prototype and rapidly iterate your domain model
+    Prototype and rapidly iterate your domain model with core DDD tactical
+    patterns.
 
 -   __Technology Agnostic__
 
     ---
 
-    Model your domain without worrying about technology choices
+    Model your domain without worrying about technology choice. Delay your
+    decisions until the last responsible moment.
 
 -   __Pluggable Adapters__
 
     ---
 
-    Use a Configuration-based approach to specify technology choices
+    Use a Configuration-based approach to specify your application's
+    infrastructure. Decouple your application from your technology.
 
--   __Multi-domain Support__
+-   __Multi-domain Codebase__
 
     ---
 
-    Evolve and structure bounded contexts over time
+    Evolve and structure your application's bounded contexts over time as you
+    understand better.
 
 -   __Event-centric Communication__
 
     ---
 
-    Use Domain Events to sync state across Aggregates and Bounded contexts
+    Use Domain Events to sync state across Aggregates and Bounded contexts,
+    creating a loosely-coupled, highly-scalable ecosystem.
+
+-   __100% Coverage__
+
+    ---
+
+    Completely cover your domain model with tests that can run in memory or
+    with your chosen technlogies.
 
 </div>
 

docs/overrides/partials/languages/custom.html

@@ -0,0 +1,56 @@
+{% macro t(key) %}{{ {
+    "language": "en",
+    "direction": "ltr",
+    "action.edit": "Edit this page",
+    "action.skip": "Skip to content",
+    "action.view": "View source of this page",
+    "announce.dismiss": "Don't show this again",
+    "blog.archive": "Archive",
+    "blog.categories": "Categories",
+    "blog.categories.in": "in",
+    "blog.continue": "Continue reading",
+    "blog.draft": "Draft",
+    "blog.index": "Back to index",
+    "blog.meta": "Metadata",
+    "blog.references": "Related links",
+    "clipboard.copy": "Copy to clipboard",
+    "clipboard.copied": "Copied to clipboard",
+    "consent.accept": "Accept",
+    "consent.manage": "Manage settings",
+    "consent.reject": "Reject",
+    "footer": "Footer",
+    "footer.next": "Next",
+    "footer.previous": "Previous",
+    "header": "Header",
+    "meta.comments": "Comments",
+    "meta.source": "Source",
+    "nav": "Navigation",
+    "readtime.one": "1 min read",
+    "readtime.other": "# min read",
+    "rss.created": "RSS feed",
+    "rss.updated": "RSS feed of updated content",
+    "search": "Search",
+    "search.config.lang": "en",
+    "search.config.pipeline": "stopWordFilter",
+    "search.config.separator": "[\\s\\-]+",
+    "search.placeholder": "Search",
+    "search.share": "Share",
+    "search.reset": "Clear",
+    "search.result.initializer": "Initializing search",
+    "search.result.placeholder": "Type to start searching",
+    "search.result.none": "No matching documents",
+    "search.result.one": "1 matching document",
+    "search.result.other": "# matching documents",
+    "search.result.more.one": "1 more on this page",
+    "search.result.more.other": "# more on this page",
+    "search.result.term.missing": "Missing",
+    "select.language": "Select language",
+    "select.version": "Select version",
+    "source": "Go to repository",
+    "source.file.contributors": "Contributors",
+    "source.file.date.created": "Created",
+    "source.file.date.updated": "Last update",
+    "tabs": "Tabs",
+    "toc": "On this page",
+    "top": "Back to top"
+  }[key] }}{% endmacro %}

docs/start-here.md

@@ -1,8 +1,3 @@
----
-hide:
-  - navigation
----
-
 # Start Here
 
 Welcome to Protean! Whether you're a seasoned developer or new to the framework, this guide will help you navigate the documentation and get started on the right foot.
@@ -15,7 +10,8 @@ Get to know the driving principles and core ideas that shape this framework in [
 
 ## Building with Protean
 
-Everything you need to know to build ambitious applications with Protean.
+Everything you need to know to build ambitious applications with Protean is in
+the [Guides](./guides/getting-started/installation.md) section.
 
 - Craft rich domain models that capture your business concepts and rules in [Domain Model](./guides/compose-a-domain/index.md).
 

docs/stylesheets/extra.css

@@ -73,4 +73,9 @@ p a, article ul li a {
 
 .md-tabs {
   background-color: var(--md-primary-bg-color-light);
+}
+
+/* Logo Height */
+.md-header__button.md-logo img, .md-header__button.md-logo svg {
+  height: 2rem;
 }

mkdocs.yml

@@ -6,6 +6,10 @@ copyright: Copyright © 2019 - 2024 Subhash Bhushan
 
 theme:
   name: material
+  custom_dir: docs/overrides
+  logo: assets/logo.png
+  favicon: assets/favicon.png
+  language: custom
   font:
     text: Inter
     code: JetBrains Mono
@@ -64,11 +68,11 @@ markdown_extensions:
       check_paths: true
       base_path: docs_src
 nav:
-  - Protean: index.md
-  - Start Here: start-here.md
-  - Core Concepts:
+  - Protean:
+    - index.md
+    - start-here.md
     - core-concepts/philosophy.md
-    - core-concepts/whitepaper.md
+  - Core Concepts:
     - core-concepts/analysis-model.md
     - core-concepts/streams.md
     # - core-concepts/identity.md
@@ -103,7 +107,6 @@ nav:
     #   - core-concepts/event-sourcing/snapshots.md
     #   - core-concepts/event-sourcing/projections.md
   - Guides:
-    - guides/index.md
     - guides/getting-started/installation.md
     #  - guides/getting-started/quickstart.md