Update SEO and add missing documentation

vivekjoshy · Dec 10, 2022 · a1acf12 · a1acf12
1 parent 7587162
commit a1acf12
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -112,11 +112,11 @@
     "source_branch": "main",
     "source_directory": "docs/",
 }
-html_title = "OpenSkill for Python"
+html_title = "OpenSkill - Multiplayer rating system. Better than Elo."
 
 # OGP Config
 ogp_site_url = "https://openskill.me/en/stable/"
-ogp_site_name = "OpenSkill for Python"
+ogp_site_name = "OpenSkill - Multiplayer rating system. Better than Elo."
 ogp_image = "https://i.imgur.com/tSTFzZY.gif"
 ogp_description_length = 300
 ogp_type = "website"

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,4 +1,4 @@
-:og:description: openskill.py is an n-player, n-team skill rating system with the ability to predict match outcomes (like win and draw) with upto 90% accuracy given enough data.
+:og:description: Multiplayer rating system. Better than Elo.
 :og:image: https://i.imgur.com/tSTFzZY.gif
 :og:image:alt: OpenSkill for Python
 
@@ -9,7 +9,13 @@
 openskill.py
 ============
 
-This is the documentation of **openskill** for python. It is an n-player, n-team skill rating system with the ability to predict match outcomes (like win and draw) with upto 90% accuracy given enough data.
+Multiplayer rating system. Better than Elo.
+
+
+.. image:: https://i.imgur.com/tSTFzZY.gif
+
+
+It is an n-player, n-team skill rating system with the ability to predict match outcomes (like win and draw) with upto 90% accuracy given enough data.
 
 Contents
 ========

diff --git a/docs/manual.rst b/docs/manual.rst
@@ -4,6 +4,7 @@
 
 .. image:: https://i.imgur.com/tSTFzZY.gif
 
+
 A faster and open license multi-team, multiplayer rating system comparable to TrueSkill.
 
 This is a port of the amazing `openskill.js`_ package and some of it's models are based on this wonderful `paper`_.
@@ -125,6 +126,8 @@ You can compare two or more teams to get the probabilities of the match drawing.
 Predicting Ranks
 ----------------
 
+Sometimes you want to know what the likelihood is someone will place at a particular rank. You can use this library to predict those odds.
+
 .. code:: python
 
    >>> from openskill import predict_rank, predict_draw