From 6372cd1ce1d9bbad15e2615c2ee5fcd8b9de93b3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gustavo=20Viera=20L=C3=B3pez?= <gvieralopez>
Date: Thu, 8 Jun 2023 14:26:19 +0200
Subject: [PATCH] Update documentation

---
 docs/source/contributing/engaging.rst      | 46 +++++++++++++++++++++-
 docs/source/contributing/report_issues.rst |  2 -
 docs/source/index.rst                      |  1 -
 3 files changed, 45 insertions(+), 4 deletions(-)
 delete mode 100644 docs/source/contributing/report_issues.rst

diff --git a/docs/source/contributing/engaging.rst b/docs/source/contributing/engaging.rst
index c70c628..10a321d 100644
--- a/docs/source/contributing/engaging.rst
+++ b/docs/source/contributing/engaging.rst
@@ -1,2 +1,46 @@
 Increasing Visibility and Engagement
-====================================
\ No newline at end of file
+====================================
+
+Do you want to help with the development of pactus? We have some ideas on how to do it:
+
+
+Bug reporting
+-------------
+
+Your script isn't working, and you are sure the issue lies with pactus? Make sure 
+you are using the latest available pypi package and if the problem persists, 
+open an issue in `GitHub <https://github.com/yupidevs/pactus/issues>`_ to let us know.
+
+
+Requesting new features
+-----------------------
+
+You can similarly use the issues in `GitHub <https://github.com/yupidevs/pactus/issues>`_ to
+suggest new features you want to see in new releases of pactus.
+
+
+Extending pactus source code
+----------------------------
+
+If you want to contribute directly to the project (improve documentation, implement new 
+features or fix existing bugs) you can make a pull request and we will analyze it as soon as 
+possible. Moreover, we have dedicated guidelines for contributions focused on adding datasets,
+models or featurizers. You can find them right after this page.
+
+
+Adding new examples of usage
+----------------------------
+
+Even without contributing to the pactus source code, if you use pactus for your research, you 
+can request the addition of your scripts to the examples hosted in the documentation. We will
+evaluate the proposal according to the quality of the results and the differences among already
+existing examples.
+
+Increasing pactus visibility
+----------------------------
+
+To help us reach a broader audience in the scientific community, you can help us by:
+
+ * Star the project `pactus <https://github.com/yupidevs/pactus/stargazers>`_ in GitHub 
+ * Star the project `yupi <https://github.com/yupidevs/yupi/stargazers>`_ in GitHub 
+ * Cite the pactus arxiv paper that is going to be available soon in here
diff --git a/docs/source/contributing/report_issues.rst b/docs/source/contributing/report_issues.rst
deleted file mode 100644
index 275423f..0000000
--- a/docs/source/contributing/report_issues.rst
+++ /dev/null
@@ -1,2 +0,0 @@
-Report issues
-=============
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 7420bb5..0d3424c 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -61,7 +61,6 @@ extensible way, so the users can build their own models and datasets.
    :caption: Contributing
   
    contributing/engaging
-   contributing/report_issues
    contributing/adding_datasets
    contributing/adding_models
    contributing/adding_featurizers