feat: brand site and add social sharing (closes #2)

Author: d-sys-admin

.github/workflows/ci.yml

@@ -24,5 +24,5 @@ jobs:
           path: .cache 
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs mkdocs-terminal mkdocs-git-revision-date-plugin 'mkdocs-spellcheck[symspellpy]' mkdocs-llmstxt mkdocs-rss-plugin
+      - run: pip install mkdocs mkdocs-terminal mkdocs-git-revision-date-plugin 'mkdocs-spellcheck[symspellpy]' mkdocs-llmstxt mkdocs-rss-plugin mkdocs-ultralytics-plugin
       - run: mkdocs gh-deploy --force

README.md

@@ -1,27 +1,50 @@
-# d-sys.wiki
+# d-sys.wiki - all things distributed systems
 
 [![ci](https://github.com/captradeoff/d-sys-wiki/actions/workflows/ci.yml/badge.svg)](https://github.com/captradeoff/d-sys-wiki/actions/workflows/ci.yml)
 [![license: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](http://creativecommons.org/publicdomain/zero/1.0/)
+[![github stars](https://img.shields.io/github/stars/captradeoff/d-sys-wiki?style=social)](https://github.com/captradeoff/d-sys-wiki/stargazers)
+[![github forks](https://img.shields.io/github/forks/captradeoff/d-sys-wiki?style=social)](https://github.com/captradeoff/d-sys-wiki/network/members)
+[![twitter follow](https://img.shields.io/twitter/follow/captradeoff?style=social)](https://twitter.com/captradeoff)
 
-**d-sys.wiki** is a resource for distributed systems. this repo contains the source for [d-sys.wiki](https://d-sys.wiki) website, providing explanations, resources, and tools for understanding and building distributed systems.
+> your home for all things distributed systems. **[⭐ star this repo](#-support-this-project)** if you find it useful!
+
+## 📋 table of contents
+
+- [description](#-description)
+- [content](#-content)
+- [getting started](#-getting-started)
+- [contributing](#-contributing)
+- [project structure](#️-project-structure)
+- [support this project](#-support-this-project)
+- [contact](#-contact)
+- [license](#-license)
+
+## 📝 description
+
+**d-sys.wiki** is a comprehensive resource for distributed systems knowledge. this repository contains the source for the [d-sys.wiki](https://d-sys.wiki) website, providing clear explanations, valuable resources, and practical tools for understanding and building distributed systems.
+
+created to be easily consumed by both humans and AI, this wiki enhances distributed systems skills through accessible content and practical examples.
 
 ## 📚 content
 
-- simple explanations of distributed systems concepts
-- pre-prints on distributed systems research
-- case studies with code examples
-- open source projects and tools
-- links to books and talks
+- **simple explanations**: clear breakdowns of complex distributed systems concepts
+- **research access**: early access to pre-prints on distributed systems research
+- **practical examples**: case studies with reproducible code examples
+- **curated resources**: open source projects, software, and tools
+- **learning materials**: links to top books and talks in the field
+- **community-driven**: open to contributions from distributed systems experts
 
 ## 🚀 getting started
 
 ### for readers
 
-visit [d-sys.wiki](https://d-sys.wiki) to access the content.
+visit [d-sys.wiki](https://d-sys.wiki) to access all content immediately - no setup required!
 
 ### for contributors
 
-built with [mkdocs](https://www.mkdocs.org/) using terminal theme.
+the site is built with [mkdocs](https://www.mkdocs.org/) using the terminal theme.
+
+clone this wiki's style for your next docsite with the [d-sys.wiki documentation template](https://github.com/captradeoff/d-sys-wiki-documentation-template) for github pages.
 
 #### prerequisites
 
@@ -55,19 +78,22 @@ built with [mkdocs](https://www.mkdocs.org/) using terminal theme.
 
 ## 📝 contributing
 
-1. **report issues**: [open an issue](https://github.com/captradeoff/d-sys-wiki/issues)
+we welcome contributions from the community! here's how you can help:
+
+1. **report issues**: [open an issue](https://github.com/captradeoff/d-sys-wiki/issues) if you find errors or have suggestions
 
 2. **submit content**:
    - fork the repo
    - create a branch
    - edit markdown in `wiki/`
    - submit pull request
 
-3. **guidelines**:
-   - write clearly
-   - include examples
-   - cite sources
-   - follow existing format
+3. **contribution guidelines**:
+   - write clearly and concisely
+   - include practical examples where applicable
+   - cite sources for technical information
+   - follow the existing format and style
+   - keep explanations accessible to various skill levels
 
 ## 🏗️ project structure
 
@@ -80,18 +106,35 @@ d-sys-wiki/
 │   └── img/               # images
 ├── mkdocs.yml             # config
 ├── CNAME                  # domain config
-└── LICENSE                # mit license
+└── LICENSE                # license file
 ```
 
-## 📄 license
+## ⭐ support this project
+
+if you find this project useful, please consider:
 
-mit license - see [license](LICENSE) file.
+- ⭐ [starring the repository](https://github.com/captradeoff/d-sys-wiki/stargazers) on github
+- 🔄 [forking the repository](https://github.com/captradeoff/d-sys-wiki/fork) to contribute
+- 📢 sharing [d-sys.wiki](https://d-sys.wiki) with others in the distributed systems community
+- 🐛 [reporting bugs](https://github.com/captradeoff/d-sys-wiki/issues) or suggesting features
+- 💻 submitting pull requests to improve the content or documentation
+- 🤝 [joining our discord community](https://discord.gg/abnrNxa7J5) for discussions
+
+your support helps maintain and improve this resource for everyone!
 
 ## 📬 contact
 
 - github: [@captradeoff](https://github.com/captradeoff)
 - twitter/x: [@captradeoff](https://x.com/captradeoff)
+- x community: [join our community](https://x.com/i/communities/1903531139035476424)
+- discord: [join our server](https://discord.gg/abnrNxa7J5)
+
+## 📄 license
+
+[CC0-1.0](LICENSE) - dedicated to the public domain.
+
+---
 
-## License
+**[⬆ back to top](#d-syswiki---all-things-distributed-systems)**
 
-MIT
+**[🌐 visit d-sys.wiki now](https://d-sys.wiki)**

mkdocs.yml

@@ -1,6 +1,6 @@
 site_name: d-sys.wiki
 site_url: https://d-sys.wiki
-copyright: "This work is dedicated to the public domain under CC0 1.0."
+copyright: "this work is dedicated to the public domain under CC0 1.0."
 site_author: captradeoff
 repo_url: https://github.com/captradeoff/d-sys-wiki
 edit_uri: edit/master/docs/
@@ -12,14 +12,24 @@ nav:
       - Index: "fundamentals/index.md"
   - llms: "llms.txt"
   - rss: "feed_rss_updated.xml"
-  
+
 plugins:
+  - ultralytics:
+      verbose: True
+      enabled: True
+      default_image: "https://d-sys.wiki/img/captradeoff.jpg"
+      default_author: "@captradeoff"
+      add_desc: True
+      add_image: True
+      add_keywords: True
+      add_share_buttons: False
+      add_json_ld: True
   - rss
   - llmstxt:
       files:
         - output: llms.txt
           inputs:
-            - '**.md'
+            - "**.md"
   - search
   - git-revision-date
   - spellcheck:
@@ -42,4 +52,10 @@ markdown_extensions:
       permalink_title: Anchor link to this section for reference
 
 extra_css:
-  - style.css
+  - style.css
+
+extra:
+  social:
+    image: wiki/img/captradeoff.png
+    description: "public domain distributed systems wiki with notes, research, and code"
+    title: "d-sys.wiki – all things distributed systems"

theme/main.html

@@ -1,4 +1,6 @@
 {% extends "base.html" %} {% block extrahead %}
+<meta name="twitter:site" content="@dsyswiki" />
+<meta name="twitter:creator" content="@captradeoff" />
 <!-- RSS Feed -->
 <link
   rel="alternate"
@@ -20,7 +22,15 @@
   href="{{ config.site_url }}llms.txt"
 />
 {% endblock %} {% block footer %}
-<p>{{ config.copyright }} <a href="/license/">view license</a></p>
+<div style="width: 100%; text-align: center; margin: 15px auto;">
+    <a href="#" onclick="window.open('https://twitter.com/intent/tweet?url=' + encodeURIComponent(window.location.href), 'TwitterShare', 'width=550,height=680,menubar=no,toolbar=no'); return false;" class="hover-item" style="color: white; margin: 0 15px; display: inline-block;">
+        <i class="fa-brands fa-x-twitter"></i> Share on X
+    </a>
+    <a href="#" onclick="window.open('https://www.linkedin.com/shareArticle?url=' + encodeURIComponent(window.location.href), 'LinkedinShare', 'width=550,height=730,menubar=no,toolbar=no'); return false;" class="hover-item" style="color: white; margin: 0 15px; display: inline-block;">
+        <i class="fa-brands fa-linkedin-in"></i> Share on LinkedIn
+    </a>
+</div>
+<p style="text-align: center;">{{ config.copyright }} <a href="/license/">license</a></p>
 <table class="table table-striped table-hover">
   <tbody>
     <tr>
@@ -53,6 +63,4 @@
     </tr>
   </tbody>
 </table>
-<p>Attribution optional, but appreciated.</p>
-
-{% endblock %}
+<p style="text-align: center;"><a href="https://github.com/captradeoff/d-sys-wiki-documentation-template">d-sys.wiki documentation template</a></p>{% endblock %}

wiki/fundamentals/index.md

@@ -1,3 +1,7 @@
+---
+title: "distributed systems fundamentals - d-sys.wiki"
+description: "A comprehensive guide to distributed systems fundamentals covering definitions, CAP theorem, architectures, core components, and key design considerations for building resilient and scalable systems"
+---
 # distributed systems fundamentals
 
 ## what are distributed systems?

wiki/img/captradeoff.jpg

@@ -1,4 +1,6 @@
 ---
+title: "d-sys.wiki - all things distributed systems"
+description: "A comprehensive public domain wiki for distributed systems knowledge, featuring explanations, research, code examples, and resources designed for both human and AI consumption"
 hide:
     - revision_date
     - revision_history