Add deprecation notices (#255)

Add deprecation notice to README and as header for each page on the docs themselves.
R2Northstar · Sep 24, 2024 · 05a7b04 · 05a7b04
1 parent fb7c1f3
commit 05a7b04
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -1,6 +1,9 @@
 Titanfall 2 + Northstar Modding Docs
 ====================================
 
+.. warning::
+    **The ModdingDocs are outdated and have been deprecated in favour of the new** `Northstar Documentation <https://docs.northstar.tf/Modding/>`_!
+
 This repo contains documentation and guides on most things you need to know about creating mods for Northstar.
 
 Especially the technical documentation is not done yet and might be incorrect or outdated in some places.

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -5,6 +5,10 @@
 project = "Northstar Modding"
 copyright = "2022, Northstar Developer Team"
 author = "Northstar Developer Team"
+rst_prolog = """
+.. warning::
+    **The ModdingDocs are outdated and have been deprecated in favour of the new** `Northstar Documentation <https://docs.northstar.tf/Modding/>`_!
+"""
 
 # -- General configuration