docs: add intro for openedx events documentation

openedx · Nov 25, 2024 · d7e579d · d7e579d
1 parent 5d52550
commit d7e579d
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/docs/concepts/index.rst b/docs/concepts/index.rst
@@ -5,4 +5,4 @@ Concepts
    :maxdepth: 1
    :caption: Contents:
 
-   :doc:`docs.openedx.org:developers/concepts/hooks_extension_framework`
+   openedx-events
diff --git a/docs/conf.py b/docs/conf.py
@@ -128,7 +128,7 @@
 
 intersphinx_mapping = {
     "docs.openedx.org": (
-        f"https://docs.openedx.org/{rtd_language}/{rtd_version}/",
+        f"https://docs.openedx.org/{rtd_language}/{rtd_version}",
         None,
     ),
 }
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,8 @@
 Welcome to Open edX Events' documentation!
 ============================================
 
+Open edX Events is type of hook in the Hooks Extension Framework that allows extending the Open edX platform in a more stable and maintainable way. If you're new to this approach for extending Open edX, start by reading the :doc:`docs.openedx.org:developers/concepts/hooks_extension_framework` documentation. This documentation provides an overview of the framework's concepts and structure useful to support your adoption of Open edX Events.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents: