Doc UI ref - fix links (#1476)

* Revising UI reference * UI ref changes. Reorganized and reformatted UI reference. * Revising the Covalent GUI reference. * Revised the UI reference. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Addressed initial review comments for UI reference. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Addressed 2nd round of review comments. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Addressed initial review comments for UI reference. * Fixed broken links from UI Ref PR. * Update CHANGELOG.md adding it outside of unreleased * Update CHANGELOG.md * Update CHANGELOG.md re adding space * Update CHANGELOG.md * Revising UI reference - rebase develop * UI ref changes. Reorganized and reformatted UI reference. * Revising the Covalent GUI reference. * Revised the UI reference. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Addressed initial review comments for UI reference. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Addressed 2nd round of review comments. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Fixed broken links from UI Ref PR. Co-authored-by: dwelsch-memverge <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Santosh kumar <[email protected]> Co-authored-by: Will Cunningham <[email protected]>
AgnostiqHQ · Jan 17, 2023 · 27709cc · 27709cc
1 parent 24031b5
commit 27709cc
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Docs
 - Revised UI reference. Added Settings page documentation.
+- Added broken UI links in README
 
 ## [0.212.1-rc.0] - 2023-01-14
 

diff --git a/README.md b/README.md
@@ -53,11 +53,11 @@ Covalent is developed using Python version 3.8 on Linux and macOS. The easiest w
 pip install covalent
 ```
 
-Refer to the [Getting Started](https://covalent.readthedocs.io/en/latest/getting_started/index.html) guide for detailed setup instructions. For a full list of supported platforms, see the Covalent [compatibility matrix](https://covalent.readthedocs.io/en/latest/getting_started/compatibility.html).
+Refer to the [Quick Start](https://covalent.readthedocs.io/en/latest/getting_started/quick_start/index.html) guide for quick setup instructions, or to the [First Experiment](https://covalent.readthedocs.io/en/latest/getting_started/first_experiment/index.html) guide for a more thorough approach. For a full list of supported platforms, see the Covalent [compatibility matrix](https://covalent.readthedocs.io/en/latest/getting_started/compatibility.html).
 
 ## 🚀 Getting started
 
-Ready to try it? Go to the [Getting Started](https://covalent.readthedocs.io/en/latest/getting_started/index.html) guide in the documentation.
+Ready to try it? Go to the [First Experiment](https://covalent.readthedocs.io/en/latest/getting_started/first_experiment/index.html) guide in the documentation.
 
 For a more in-depth description of Covalent's features and how they work, see the [Concepts](https://covalent.readthedocs.io/en/latest/concepts/concepts.html) page in the documentation.
 
@@ -69,10 +69,10 @@ For a more in-depth description of Covalent's features and how they work, see th
  <tr>
     <td>
 
-  - [What is covalent ?](https://www.covalent.xyz/what-is-covalent/)
+  - [What is Covalent?](https://www.covalent.xyz/what-is-covalent/)
   - [Covalent in the era of cloud-HPC](https://www.covalent.xyz/navigating-the-modern-hpc-landscape/)
-  - [Basic Concepts of Covalent](https://covalent.readthedocs.io/en/stable/concepts/concepts.html)
-  - [How does covalent work ?](#how-does-it-work)
+  - [Basic Concepts of Covalent](https://covalent.readthedocs.io/en/latest/concepts/concepts.html)
+  - [How does Covalent work?](#how-does-it-work)
 </td>
     <td>
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -58,7 +58,7 @@ Get Started
 
     ------------------------------------------------
 
-    .. link-button:: getting_started/index
+    .. link-button:: getting_started/first_experiment/index
         :type: ref
         :text: First Experiment
         :classes: btn-outline-primary btn-block stretched-link

diff --git a/doc/source/webapp_ui/settings/api.rst b/doc/source/webapp_ui/settings/api.rst
@@ -20,4 +20,4 @@ Enable Logging
 Executor Directory
     The directory path containing remote executor plugin modules used by the SDK.
 No Cluster
-    Turn Dask clustering on (False) or off (True). With `No Cluster` set to True, the default executor is local.
+    Turn Dask clustering on (False) or off (True). With No Cluster set to True, the default executor is local.