Documentation and Readme (#521)

* updated readme

* updated readme

* updating README

* update link on readme

* fix newline

* solving #508

* all additional docs files

* Create CODE_OF_CONDUCT.md

* Update CODE_OF_CONDUCT.md

Added license header

* updating docs

* elaborating main page, adding images and symlinks, small readme fixes, elaboratin key concepts

* changed links color and added pip install to notebook

* tried to add new link colors, updated key concepts, and notebook mak depth

* fixing docs

* fixes

* typo

* Update README.rst

* Update README.rst

fixing image

* Update README.rst

removing comment

* Update README.rst

fixing image path

* broken link and title

* trying to add diagram and logo

* fixing images

Co-authored-by: Itay Gabbay <itay@deepchecks.com>

CODE_OF_CONDUCT.md

@@ -0,0 +1,141 @@
+   <!--
+     ~ ----------------------------------------------------------------------------
+     ~ Copyright (C) 2021 Deepchecks (https://www.deepchecks.com)
+     ~
+     ~ This file is part of Deepchecks.
+     ~ Deepchecks is distributed under the terms of the GNU Affero General
+     ~ Public License (version 3 or later).
+     ~ You should have received a copy of the GNU Affero General Public License
+     ~ along with Deepchecks.  If not, see <http://www.gnu.org/licenses/>.
+     ~ ----------------------------------------------------------------------------
+     ~
+   -->
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+community_leader@deepchecks.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.rst

@@ -31,7 +31,7 @@
 .. raw:: html
 
    <p align="center">
-      <a href="https://deepchecks.com/blog/?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=logo">
+      <a href="https://deepchecks.com/?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=logo">
       <img src="docs/images/deepchecks-logo-with-white-wide-back.png">
       </a>
    </p>
@@ -66,22 +66,29 @@ Using conda
 
    conda install -c deepchecks deepchecks
 
+
+Try it Out!
+============
+
+Head over to the `Quickstart Notebook <https://docs.deepchecks.com/en/stable/
+examples/guides/quickstart_in_5_minutes.html?
+utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=try_it_out>`__
+and choose the  |binder badge image|  or the  |colab badge image|  to have it up and running, and to then apply it on your own data and models.
+
+
 Usage Examples
 ===============
 
 Running a Suite
 ----------------
-A `Suite <#suite>`__ runs a collection of `Checks <#check>`__ with
-optional `Conditions <#condition>`__ added to them.
+A `Suite <#suite>`_ runs a collection of `Checks <#check>`_ with
+optional `Conditions <#condition>`_ added to them.
 
-Try it Out!
-~~~~~~~~~~~~
-For a full suite demonstration, check out the `Quickstart
-Notebook <https://docs.deepchecks.com/en/stable/examples/guides/quickstart_in_5_minutes.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme>`__
-and apply it on your own data and models. You can launch it directly on google colab or on binder from within the documentation.
+To see it in action, we recommend `trying it out <#try-it-out>`_.
 
-Quick Code Example
-~~~~~~~~~~~~~~~~~~~~
+To run an existing suite all you need to do is to import the suite and run 
+it with the required (suite-dependent) input parameters.
+The list of all built-in suites can be found `here <deepchecks/suites>`_.
 
 Let's take the "iris" dataset as an example
 
@@ -90,16 +97,22 @@ Let's take the "iris" dataset as an example
    from sklearn.datasets import load_iris
    iris_df = load_iris(return_X_y=False, as_frame=True)['frame']
 
-To run an existing suite all you need to do is to import the suite and
-to run it with the required (suite-dependent) input parameters
+and run the `single_dataset_integrity` suite, which requires only a single `Dataset`_
+and can run also directly on a `pd.DataFrame`, like in the following example.
+
+.. _Dataset:
+   https://docs.deepchecks.com/en/stable/
+   user-guide/dataset_object.html
+   ?utm_source=github.com&utm_medium=referral&
+   utm_campaign=readme&utm_content=running_a_suite
 
 .. code:: python
 
    from deepchecks.suites import single_dataset_integrity
    suite = single_dataset_integrity()
    suite.run(iris_df)
 
-Which will result in printing the suite outputs, starting with a summary
+Will result in printing the suite's output, that starts with a summary
 of the check conditions
 
    .. raw:: html
@@ -113,7 +126,7 @@ of the check conditions
          ),
              as well as other outputs such as plots or tables.<br>
              Suites, checks and conditions can all be modified (see the 
-             <a href='https://docs.deepchecks.com/en/stable/examples/guides/create_a_custom_suite.html'>Create a Custom Suite</a> tutorial).</p>
+             <a href='https://docs.deepchecks.com/en/stable/examples/guides/create_a_custom_suite.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=suite_output_link'>Create a Custom Suite</a> tutorial).</p>
 
    .. raw:: html
 
@@ -181,15 +194,22 @@ of the check conditions
       </table>
 
 Followed by the visual outputs of all of the checks that are in that
-suite, that isn't appended here for brevity.
+suite, that isn't appended here for brevity. In the following section 
+you can see an example of how the output of a single check may look.
 
 Running a Check
 ----------------
 
 To run a specific single check, all you need to do is import it and then
 to run it with the required (check-dependent) input parameters. More
 details about the existing checks and the parameters they can receive
-can be found in our `API Reference <https://docs.deepchecks.com/en/stable/api/index.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=running_a_check>`__.
+can be found in our `API Reference`_.
+
+.. _API Reference:
+   https://docs.deepchecks.com/en/stable/
+   api/index.html?
+   utm_source=github.com&utm_medium=referral&
+   utm_campaign=readme&utm_content=running_a_check
 
 .. code:: python
 
@@ -201,7 +221,7 @@ can be found in our `API Reference <https://docs.deepchecks.com/en/stable/api/in
    # Initialize and run desired check
    TrainTestFeatureDrift().run(train_data, test_data)
 
-Which will produce output of the type:
+Will produce output of the type:
 
    .. raw:: html
 
@@ -228,8 +248,13 @@ covering all kinds of common issues, such as:
 - Model Error Analysis
 - Label Ambiguity
 - Data Sample Leakage
-and `many more checks <https://docs.deepchecks.com/en/stable/api/checks/index.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=key_concepts__check>`__.
+and `many more checks`_.
 
+.. _many more checks:
+   https://docs.deepchecks.com/en/stable/
+   api/checks/index.html
+   ?utm_source=github.com&utm_medium=referral&
+   utm_campaign=readme&utm_content=key_concepts__check
 
 Each check can have two types of
 results:
@@ -261,19 +286,24 @@ Suite
 
 An ordered collection of checks, that can have conditions added to them.
 The Suite enables displaying a concluding report for all of the Checks
-that ran. See the list of `predefined existing suites <deepchecks/suites>`__
+that ran. See the list of `predefined existing suites`_
 to learn more about the suites you can work with directly and also to
 see a code example demonstrating how to build your own custom suite.
 The existing suites include default conditions added for most of the checks.
 You can edit the preconfigured suites or build a suite of your own with a collection
 of checks and optional conditions.
 
+.. _predefined existing suites: deepchecks/suites
+
+.. include:: 
+
 .. raw:: html
 
    <p align="center">
-      <img src="docs/images/diagram.svg">
+      <img src="/docs/images/diagram.svg">
    </p>
-
+
+
 What Do You Need in Order to Start Validating?
 ----------------------------------------------
 
@@ -293,8 +323,9 @@ subset of the following:
 Deepchecks validation accompanies you from the initial phase when you
 have only raw data, through the data splits, and to the final stage of
 having a trained model that you wish to evaluate. Accordingly, each
-phase requires different assets for the validation. See more about
-typical usage scenarios and the built-in suites in the
+phase requires different assets for the validation.
+
+See more about typical usage scenarios and the built-in suites in the
 `docs <https://docs.deepchecks.com/?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utme_content=what_do_you_need_in_order_to_start_validating>`__.
 
 Documentation
@@ -316,6 +347,7 @@ Community
    Issue <https://github.com/deepchecks/deepchecks/issues>`__ to suggest
    improvements, open an issue, or share feedback.
 
+
 .. |build| image:: https://github.com/deepchecks/deepchecks/actions/workflows/build.yml/badge.svg
 .. |Documentation Status| image:: https://readthedocs.org/projects/deepchecks/badge/?version=latest
    :target: https://docs.deepchecks.com/?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=badge
@@ -325,3 +357,8 @@ Community
    :target: https://codeclimate.com/github/deepchecks/deepchecks/maintainability
 .. |Coverage Status| image:: https://coveralls.io/repos/github/deepchecks/deepchecks/badge.svg?branch=main
    :target: https://coveralls.io/github/deepchecks/deepchecks?branch=main
+
+.. |binder badge image| image:: /docs/source/_static/binder-badge.svg
+   :target: https://docs.deepchecks.com/en/stable/examples/guides/quickstart_in_5_minutes.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=try_it_out_binder
+.. |colab badge image| image:: /docs/source/_static/colab-badge.svg
+   :target: https://docs.deepchecks.com/en/stable/examples/guides/quickstart_in_5_minutes.html?utm_source=github.com&utm_medium=referral&utm_campaign=readme&utm_content=try_it_out_colab

docs/source/_static/css/custom.css

@@ -1,4 +1,16 @@
 
 .bd-sidebar {
-    z-index: auto
+  z-index: auto
+}
+
+:root {
+  /*****************************************************************************
+  * Color
+  *
+  * Colors are defined in rgb string way, "red, green, blue"
+  **/
+
+    --pst-color-link: 157, 96, 251;
+    --pst-color-link-hover: 87, 24, 184;
+
 }