docs: documentation restructuring (ivy-llc#23130)

docs/index.rst

@@ -3,13 +3,31 @@
 .. include:: ../README.md
   :parser: myst_parser.sphinx_
 
+
+.. toctree::
+  :hidden:
+  :maxdepth: -1
+
+  Home <self>
+
+
 .. toctree::
   :hidden:
   :maxdepth: -1
-  :caption: Overview
+  :caption: The Basics
 
   overview/get_started.rst
-  Examples <demos/index.rst>
+  demos/quickstart.ipynb
+
+
+.. toctree::
+  :hidden:
+  :maxdepth: -1
+  :caption: Demos
+
+  demos/learn_the_basics.rst
+  demos/guides.rst
+  demos/examples_and_demos.rst
 
 
 .. toctree::
@@ -19,7 +37,6 @@
 
   overview/motivation.rst
   overview/related_work.rst
-  overview/extensions.rst
 
 
 .. toctree::
@@ -37,17 +54,14 @@
 .. toctree::
   :hidden:
   :maxdepth: -1
-  :caption: Compiling and Transpiling
+  :caption: API Reference
 
-  compiler/setting_up.rst
-  compiler/compiler.rst
-  compiler/transpiler.rst
+  overview/one_liners.rst
 
 
 .. autosummary::
   :toctree: docs/functional
   :template: top_functional_toc.rst
-  :caption: API Reference
   :recursive:
   :hide-table:
 

docs/overview/deep_dive/ivy_frontends_tests.rst

@@ -11,7 +11,6 @@ Ivy Frontend Tests
 .. _`Ivy Tests`: https://unify.ai/docs/ivy/overview/deep_dive/ivy_tests.html
 .. _`Function Testing Helpers`: https://github.com/unifyai/ivy/blob/bf0becd459004ae6cffeb3c38c02c94eab5b7721/ivy_tests/test_ivy/helpers/function_testing.py
 .. _`CI Pipeline`: https://unify.ai/docs/ivy/overview/deep_dive/continuous_integration.html
-.. _`setting up`: https://unify.ai/docs/ivy/compiler/setting_up.html#setting-up-testing
 
 
 Introduction
@@ -802,7 +801,7 @@ The CI Pipeline runs the entire collection of Frontend Tests for the frontend th
 You will need to make sure the Frontend Test is passing for each Ivy Frontend function you introduce/modify.
 If a test fails on the CI, you can see details about the failure under `Details -> Run Frontend Tests` as shown in `CI Pipeline`_.
 
-You can also run the tests locally before making a PR. See the relevant `setting up`_ section for instructions on how to do so.
+You can also run the tests locally before making a PR. See the relevant :ref:`Setting Up Testing in PyCharm` section for instructions on how to do so.
 
 Frontend Framework Testing Configuration
 ----------------------------------------

docs/overview/get_started.rst

@@ -4,7 +4,7 @@ Get Started
 ..
 
    If you want to use **Ivy's compiler and transpiler**, make sure to follow the 
-   `setting up instructions for the API key <https://unify.ai/docs/ivy/compiler/setting_up.html>`_ 
+   :ref:`setting up instructions for the API key <Ivy's compiler and transpiler>`
    after installing Ivy!
 
 
@@ -54,3 +54,40 @@ If you are planning to contribute, you want to run the tests, or you are looking
 for more in-depth instructions, it's probably best to check out 
 the `Contributing - Setting Up <https://unify.ai/docs/ivy/overview/contributing/setting_up.html#setting-up>`_ page, 
 where OS-specific and IDE-specific instructions and video tutorials to install Ivy are available!
+
+
+Ivy's compiler and transpiler
+-----------------------------
+
+To use Ivy's compiler and transpiler, you'll need an **API key**. We are starting to 
+grant pilot access to certain users, so you can `join the waitlist <https://console.unify.ai/>`_ 
+if you want to get one! 
+
+Ivy Folder
+~~~~~~~~~~
+
+When importing Ivy for the first time, a ``.ivy`` folder will be created in your 
+working directory. If you want to keep this folder in a different location, 
+you can set an ``IVY_ROOT`` environment variable with the path of your ``.ivy`` folder.
+
+Setting Up the API key
+~~~~~~~~~~~~~~~~~~~~~~
+
+Once the ``.ivy`` folder has been created (either manually or automatically by 
+importing Ivy), you will have to paste your API key as the content of the ``key.pem`` file.
+For reference, this would be equivalent to:
+
+.. code-block:: bash
+
+    echo -n API_KEY > .ivy/key.pem
+
+Issues and Questions
+~~~~~~~~~~~~~~~~~~~~
+
+If you find any issue or bug while using the compiler and/or the transpiler, please
+raise an `issue in GitHub <https://github.com/unifyai/ivy/issues>`_ and add the ``compiler`` 
+or the ``transpiler`` label accordingly. A member of the team will get back to you ASAP!
+
+Otherwise, if you haven't found a bug but want to ask a question, suggest something, or get help 
+from the team directly, feel free to open a new post at the ``pilot-access`` forum in 
+`Ivy's discord server! <https://discord.com/invite/sXyFF8tDtm>`_ 

docs/overview/one_liners.rst

@@ -0,0 +1,29 @@
+One liners
+----------
+
+.. grid:: 1 1 3 3
+    :gutter: 4
+
+    .. grid-item-card:: ``ivy.compile()``
+        :link: one_liners/compile.rst
+
+        Compiles a ``Callable`` or set of them into an Ivy graph.
+
+    .. grid-item-card:: ``ivy.transpile()``
+        :link: one_liners/transpile.rst
+
+        Transpiles a ``Callable`` or set of them from a ``source`` framework to another
+        framework.
+
+    .. grid-item-card:: ``ivy.unify()``
+        :link: one_liners/transpile.rst
+
+        Transpiles an object into Ivy code. It's an alias to 
+        ``ivy.transpile(..., to="ivy", ...)``
+
+.. toctree::
+    :hidden:
+    :maxdepth: -1
+
+    one_liners/compile.rst
+    one_liners/transpile.rst

docs/compiler/compiler.rst → docs/overview/one_liners/compile.rst

@@ -1,5 +1,5 @@
-Graph Compiler
-==============
+``ivy.compile()``
+=================
 
 ..
 

docs/compiler/transpiler.rst → docs/overview/one_liners/transpile.rst

@@ -1,5 +1,5 @@
-Transpiler
-==========
+``ivy.transpile`` / ``ivy.unify``
+=================================
 
 ..
 
@@ -241,7 +241,7 @@ still working on some rough edges. These include:
    the inference to be correct. 
 
 Keep in mind that the transpiler uses the graph compiler under the hood, so the 
-`sharp bits of the compiler <https://unify.ai/docs/ivy/compiler/compiler.html#sharp-bits>`_ 
+`sharp bits of the compiler <https://unify.ai/docs/ivy/overview/one_liners/compile.html#sharp-bits>`_ 
 apply here as well!
 
 Examples