From 7feea264044097c6ba5c0ece33a9fb346b0c54f2 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Tue, 16 Jul 2019 17:03:20 +0200 Subject: [PATCH 1/2] docs: getting-started: fix broken links --- docs/en/get-started-legacy/index.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/en/get-started-legacy/index.rst b/docs/en/get-started-legacy/index.rst index bd3d000ce1..fa8791d9af 100644 --- a/docs/en/get-started-legacy/index.rst +++ b/docs/en/get-started-legacy/index.rst @@ -103,13 +103,13 @@ The quickest way to start development with ESP32 is by installing a prebuilt too Windows Linux - MacOS + macOS -+-----------------------------+-------------------------+----------------------------------+ -| |windows-logo| | |linux-logo| | |macos-logo| | -+-----------------------------+-------------------------+----------------------------------+ -| `Windows `_ | `Linux `_ | `Mac OS `_ | -+-----------------------------+-------------------------+----------------------------------+ ++-----------------+---------------+---------------+ +| |windows-logo| | |linux-logo| | |macos-logo| | ++-----------------+---------------+---------------+ +| Windows_ | Linux_ | `macOS`_ | ++-----------------+---------------+---------------+ .. |windows-logo| image:: ../../_static/windows-logo.png :target: ../get-started-legacy/windows-setup.html @@ -120,9 +120,9 @@ The quickest way to start development with ESP32 is by installing a prebuilt too .. |macos-logo| image:: ../../_static/macos-logo.png :target: ../get-started-legacy/macos-setup.html -.. _Windows-legacy: ../get-started-legacy/windows-setup.html -.. _Linux-legacy: ../get-started-legacy/linux-setup.html -.. _Mac OS-legacy: ../get-started-legacy/macos-setup.html +.. _Windows: ../get-started-legacy/windows-setup.html +.. _Linux: ../get-started-legacy/linux-setup.html +.. _macOS: ../get-started-legacy/macos-setup.html .. note:: From e431bfd6c28371a4d9f2fd840a654bc8de501fb5 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Wed, 17 Jul 2019 08:31:35 +0200 Subject: [PATCH 2/2] docs: getting-started: correct style of "macOS" name --- docs/en/get-started-legacy/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/get-started-legacy/index.rst b/docs/en/get-started-legacy/index.rst index fa8791d9af..25292d5d65 100644 --- a/docs/en/get-started-legacy/index.rst +++ b/docs/en/get-started-legacy/index.rst @@ -74,7 +74,7 @@ This is a detailed roadmap to walk you through the installation process. Setting up Development Environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* :ref:`get-started-setup-toolchain-legacy` for :doc:`Windows `, :doc:`Linux ` or :doc:`MacOS ` +* :ref:`get-started-setup-toolchain-legacy` for :doc:`Windows `, :doc:`Linux ` or :doc:`macOS ` * :ref:`get-started-get-esp-idf-legacy` * :ref:`get-started-setup-path-legacy` * :ref:`get-started-get-packages-legacy` @@ -165,7 +165,7 @@ Step 3. Set Environment Variables The toolchain uses the environment variable ``IDF_PATH`` to access the ESP-IDF directory. This variable should be set up on your computer, otherwise projects will not build. -These variables can be set temporarily (per session) or permanently. Please follow the instructions specific to :ref:`Windows ` , :ref:`Linux and MacOS ` in Section :doc:`add-idf_path-to-profile`. +These variables can be set temporarily (per session) or permanently. Please follow the instructions specific to :ref:`Windows ` , :ref:`Linux and macOS ` in Section :doc:`add-idf_path-to-profile`. .. _get-started-get-packages-legacy: @@ -195,7 +195,7 @@ Now you are ready to prepare your application for ESP32. You can start with :exa Copy :example:`get-started/hello_world` to the ``~/esp`` directory: -Linux and MacOS +Linux and macOS ~~~~~~~~~~~~~~~ .. code-block:: bash @@ -246,7 +246,7 @@ Step 7. Configure Navigate to your ``hello_world`` directory from :ref:`get-started-start-project-legacy` and run the project configuration utility ``menuconfig``. -Linux and MacOS +Linux and macOS ~~~~~~~~~~~~~~~ .. code-block:: bash