From 612d807e7d7be56e7d35f77acbfd0eda3e2158c2 Mon Sep 17 00:00:00 2001
From: Henri Dickson <90480431+alphatownsman@users.noreply.github.com>
Date: Thu, 6 Jun 2024 16:27:48 -0400
Subject: [PATCH] add some docs
---
docs/index.md | 2 +-
docs/stylesheets/extra.css | 7 ++++---
docs/templates/main.html | 5 ++++-
docs/upgrade.md | 2 +-
mkdocs.yml | 1 +
5 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/docs/index.md b/docs/index.md
index 2110bfe4..9ce4f9c9 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,4 +1,4 @@
-NeoDB is an open-source software and global community platform. It allows users to manage and explore collections, reviews, and ratings for various cultural products, including books, movies, music, podcasts, games, and performances. Additionally, users can share their collections, publish microblogs, and engage with others in the Fediverse. NeoDB combines the functionalities of platforms such as Mastodon, Goodreads, Letterboxd, RateYourMusic, and Podchaser, among others.
+NeoDB is an open-source software and global community platform [since 2021](story.md). It allows users to manage and explore collections, reviews, and ratings for various cultural products, including books, movies, music, podcasts, games, and performances. Additionally, users can share their collections, publish microblogs, and engage with others in the Fediverse. NeoDB integrates the functionalities of platforms like Goodreads, Letterboxd, RateYourMusic, and Podchaser, among others. It also supports self-hosting and interconnection through containerized deployment and the ActivityPub protocol.
This project is licensed under AGPLv3.
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
index d5976887..d2ea318a 100644
--- a/docs/stylesheets/extra.css
+++ b/docs/stylesheets/extra.css
@@ -1,8 +1,9 @@
:root {
--md-primary-fg-color: #0172ad;
-/* --md-primary-fg-color--light: #0172ad;*/
-/* --md-primary-fg-color--dark: #01aaff;*/
+ --md-primary-fg-color--light: #0172ad;
+ --md-primary-fg-color--dark: #0172ad;
--md-accent-fg-color: #01aaff;
-/* --md-accent-fg-color--light: #01aaff;*/
+ --md-accent-fg-color--light: #01aaff;
+ --md-accent-fg-color--dark: #01aaff;
font-family:system-ui, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, Helvetica, Arial, "Helvetica Neue", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
}
diff --git a/docs/templates/main.html b/docs/templates/main.html
index 1c0e9d16..869f169f 100644
--- a/docs/templates/main.html
+++ b/docs/templates/main.html
@@ -1,2 +1,5 @@
{% extends "base.html" %}
-{% block extrahead %}{% endblock %}
+{% block extrahead %}
+
+
+{% endblock %}
diff --git a/docs/upgrade.md b/docs/upgrade.md
index 0b6e9d63..c6350205 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -1,5 +1,5 @@
Upgrade
--------
+=======
Check the [release notes](https://github.com/neodb-social/neodb/releases), update `compose.yml` and `.env` as instructed.
diff --git a/mkdocs.yml b/mkdocs.yml
index 672eb4f6..74c44061 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -11,6 +11,7 @@ nav:
- configuration.md
- troubleshooting.md
- development.md
+ - 'Our Story': story.md
theme:
logo: assets/logo.svg
name: material