Re-organize documentation

Drop support for localized content, #2213

Restructure some content to match more closely what we have in master, #2542

docs/en/flash.md → docs/flash.md

@@ -26,4 +26,4 @@ Supported platforms: anything that runs Python, runnable .exe available for Wind
 
 Supports flashing *aggregated binaries* as for example produced by [the Docker build](build.md#docker-image).
 
-Disclaimer: the availability of [NodeMCU PyFlasher was announced on the NodeMCU Facebook page](https://www.facebook.com/NodeMCU/posts/663197460515251) but it is not an official offering of the current NodeMCU firmware team.
+Disclaimer: the availability of [NodeMCU PyFlasher was announced on the NodeMCU Facebook page](https://www.facebook.com/NodeMCU/posts/663197460515251) but it is not an official offering of the current NodeMCU firmware team.

docs/index.md

@@ -1,17 +1,10 @@
 # NodeMCU Documentation
 
-NodeMCU is an [eLua](http://www.eluaproject.net/) based firmware for the [ESP32](http://espressif.com/en/products/hardware/esp32/overview) and [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/).  The NodeMCU *firmware* is a companion project to the popular [NodeMCU dev kits](https://github.com/nodemcu/nodemcu-devkit-v1.0), ready-made open source development boards with ESP8266-12E chips.
+NodeMCU is an open source [Lua](https://www.lua.org/) based firmware for the [ESP32](http://espressif.com/en/products/hardware/esp32/overview) and [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/) and uses an on-module flash-based [SPIFFS](https://github.com/pellepl/spiffs) file system. NodeMCU is implemented in C and is layered on the [Espressif ESP-IDF](https://github.com/espressif/ESP-IDF).
+
+The firmware was initially developed as is a companion project to the popular ESP8266-based [NodeMCU development modules](https://github.com/nodemcu/nodemcu-devkit-v1.0), but the project is now community-supported, and the firmware can now be run on _any_ ESP module.
 
 Support for the new [ESP32 WiFi/BlueTooth SOC from Espressif](http://www.espressif.com/en/products/hardware/esp32/overview) is under way.
 
 ## Up-To-Date Documentation
 At the moment the only up-to-date documentation maintained by the current NodeMCU team is in English. It is part of the source code repository (`/docs` subfolder) and kept in sync with the code.
-
-We encourage you to help transferring the outdated translations (see below) into the repository.
-
-## Outdated And Sparse Documentation
-The following translations are based on outdated documentation, use them with caution. The links point to the [NodeMCU wiki on GitHub](https://github.com/nodemcu/nodemcu-firmware/wiki).
-
-- Chinese, [中文](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_cn)
-- Russian, [русский](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_ru)
-- Spanish, [español](https://github.com/nodemcu/nodemcu-firmware/wiki/nodemcu_api_es)

docs/js/extra.js

@@ -1,15 +1,9 @@
 var nodemcu = nodemcu || {};
 (function () {
   'use strict';
-  //var languageCodeToNameMap = {en: 'English', de: 'Deutsch'};
-  var languageCodeToNameMap = {en: 'English'};
-  var languageNames = values(languageCodeToNameMap);
-  var defaultLanguageCode = 'en';
 
   $(document).ready(function () {
     addToc();
-    hideNavigationForAllButSelectedLanguage();
-    addLanguageSelectorToRtdFlyOutMenu();
     replaceRelativeLinksWithStaticGitHubUrl();
   });
 
@@ -43,124 +37,20 @@ var nodemcu = nodemcu || {};
     }
   }
 
-  function hideNavigationForAllButSelectedLanguage() {
-    var selectedLanguageCode = determineSelectedLanguageCode();
-    var selectedLanguageName = languageCodeToNameMap[selectedLanguageCode];
-    // Finds all subnav elements and hides them if they're /language/ subnavs. Hence, all 'Modules' subnav elements
-    // won't be hidden.
-    // <ul class="subnav">
-    //   <li><span>Modules</span></li>
-    //   <li class="toctree-l1 ">
-    //     <a class="" href="EN/modules/node/">node</a>
-    //   </li>
-    $('.subnav li span').not(':contains(' + selectedLanguageName + ')').each(function (index) {
-      var spanElement = $(this);
-      if ($.inArray(spanElement.text(), languageNames) > -1) {
-        spanElement.parent().parent().hide();
-      }
-    });
-  }
-
-  /**
-   * Adds a language selector to the RTD fly-out menu found bottom left. Example:
-   *
-   * <dl>
-   *   <dt>Languages</dt>
-   *   <dd><a href="http://nodemcu.readthedocs.io/en/<branch>/de/">de</a></dd>
-   *   <strong>
-   *     <dd><a href="http://nodemcu.readthedocs.io/en/<branch>/en/">en</a></dd>
-   *   </strong>
-   * </dl>
-   *
-   * UGLY! That fly-out menu is added by RTD with an AJAX call after page load. Hence, we need to
-   * react to the subsequent DOM manipulation using a DOM4 MutationObserver. The provided structure
-   * is as follows:
-   *
-   * <div class="rst-other-versions">
-   *   <!-- Inserted RTD Footer -->
-   *   <div class="injected">
-   */
-  function addLanguageSelectorToRtdFlyOutMenu() {
-    var flyOutWrapper = $('.rst-other-versions');
-    // only relevant on RTD
-    if (flyOutWrapper.size() > 0) {
-      var observer = new MutationObserver(function (mutations) {
-        // since mutation on the target node was triggered we can safely assume the injected RTD div has now been added
-        var injectedDiv = $('.rst-other-versions .injected');
-        var selectedLanguageCode = determineSelectedLanguageCode();
-        var dl = document.createElement('dl');
-        var dt = document.createElement('dt');
-        dl.appendChild(dt);
-        dt.appendChild(document.createTextNode('Languages'));
-        for (var languageCode in languageCodeToNameMap) {
-          dl.appendChild(createLanguageLinkFor(languageCode, selectedLanguageCode === languageCode));
-        }
-        injectedDiv.prepend(dl);
-        // no need for that observer anymore
-        observer.disconnect();
-      });
-
-      // observed target node is the fly-out wrapper, the only event we care about is when children are modified
-      observer.observe(flyOutWrapper[0], {childList: true});
-    }
-  }
-
   /**
    * The module doc pages contain relative links to artifacts in the GitHub repository. For those links to work both
    * on GitHub (i.e. when the page is viewed on GitHub) and on RTD they are defined with a relative URL. This function
    * replaces the relative path with an absolute path based on the selected branch.
    */
   function replaceRelativeLinksWithStaticGitHubUrl() {
-    var relativePath = "../../../..";
+    var relativePath = "../../..";
     var gitHubPath = "https://github.com/nodemcu/nodemcu-firmware/tree/" + determineSelectedBranch();
     var gitHubLinks = $("a[href^='" + relativePath + "']").each(function (index) {
       var url = $(this).attr('href');
       $(this).attr('href', url.replace(relativePath, gitHubPath));
     });
   }
 
-  function createLanguageLinkFor(languageCode, isCurrentlySelected) {
-    var strong;
-    // split[0] is an '' because the path starts with the separator
-    var pathSegments = window.location.pathname.split('/');
-    var dd = document.createElement("dd");
-    var href = document.createElement("a");
-    href.setAttribute('href', '/' + pathSegments[1] + '/' + pathSegments[2] + '/' + languageCode);
-    href.appendChild(document.createTextNode(languageCode));
-    dd.appendChild(href);
-    if (isCurrentlySelected) {
-      strong = document.createElement("strong");
-      strong.appendChild(dd);
-      return strong;
-    } else {
-      return dd;
-    }
-  }
-
-  /**
-   * Analyzes the URL of the current page to find out what the selected language is. It's usually
-   * part of the location path. The code needs to distinguish between running MkDocs standalone
-   * and docs served from RTD. If no valid language could be determined the default language is
-   * returned.
-   *
-   * @returns 2-char language code
-   */
-  function determineSelectedLanguageCode() {
-    var selectedLanguageCode, path = window.location.pathname;
-    if (window.location.origin.indexOf('readthedocs') > -1) {
-      // path is like /en/<branch>/<lang>/build/ -> extract 'lang'
-      // split[0] is an '' because the path starts with the separator
-      selectedLanguageCode = path.split('/')[3];
-    } else {
-      // path is like /<lang>/build/ -> extract 'lang'
-      selectedLanguageCode = path.substr(1, 2);
-    }
-    if (!selectedLanguageCode || selectedLanguageCode.length > 2) {
-      selectedLanguageCode = defaultLanguageCode;
-    }
-    return selectedLanguageCode;
-  }
-
   /**
    * Analyzes the URL of the current page to find out what the selected GitHub branch is. It's usually
    * part of the location path. The code needs to distinguish between running MkDocs standalone
@@ -173,7 +63,11 @@ var nodemcu = nodemcu || {};
     if (window.location.origin.indexOf('readthedocs') > -1) {
       // path is like /en/<branch>/<lang>/build/ -> extract 'lang'
       // split[0] is an '' because the path starts with the separator
-      branch = path.split('/')[2];
+      var thirdPathSegment = path.split('/')[2];
+      // 'latest' is an alias on RTD for the 'dev' branch - which is the default for 'branch' here
+      if (thirdPathSegment != 'latest') {
+        branch = thirdPathSegment;
+      }
     }
     return branch;
   }
@@ -187,4 +81,4 @@ var nodemcu = nodemcu || {};
     }
     return values;
   }
-}());
+}());

docs/en/modules/adc.md → docs/modules/adc.md

@@ -1,7 +1,7 @@
 # ADC Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2017-04-22 | | | [adc.c](../../../components/modules/bthci.c)|
+| 2017-04-22 | | | [adc.c](../../components/modules/bthci.c)|
 
 The ADC module provides access to the in-built ADC1.
 

docs/en/modules/bit.md → docs/modules/bit.md

@@ -1,7 +1,7 @@
 # bit Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2014-12-24 | [https://github.com/LuaDist/bitlib](https://github.com/LuaDist/bitlib), [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [bit.c](../../../app/modules/bit.c)|
+| 2014-12-24 | [https://github.com/LuaDist/bitlib](https://github.com/LuaDist/bitlib), [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [bit.c](../../app/modules/bit.c)|
 
 
 Bit manipulation support, on 32bit integers.

docs/en/modules/bthci.md → docs/modules/bthci.md

@@ -1,7 +1,7 @@
 # BT HCI Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2016-09-29 | [DiUS](https://github.com/DiUS), [Johny Mattsson](https://github.com/jmattsson) | [Johny Mattsson](https://github.com/jmattsson) | [bthci.c](../../../components/modules/bthci.c)|
+| 2016-09-29 | [DiUS](https://github.com/DiUS), [Johny Mattsson](https://github.com/jmattsson) | [Johny Mattsson](https://github.com/jmattsson) | [bthci.c](../../components/modules/bthci.c)|
 
 The BT HCI module provides a minimal HCI-level interface to BlueTooth
 adverisements. Via this module you can set up BT LE advertisements and also

docs/en/modules/can.md → docs/modules/can.md

@@ -1,7 +1,7 @@
 # CAN Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2017-04-27 | [@ThomasBarth](https://github.com/ThomasBarth/ESP32-CAN-Driver/), zelll | | [can.c](../../../components/modules/can.c)|
+| 2017-04-27 | [@ThomasBarth](https://github.com/ThomasBarth/ESP32-CAN-Driver/), zelll | | [can.c](../../components/modules/can.c)|
 
 The CAN module provides access to the in-built CAN controller.
 

docs/en/modules/dac.md → docs/modules/dac.md

@@ -1,7 +1,7 @@
 # DAC Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2018-10-14 | [Arnim Läuger](https://github.com/devsaurus) | [Arnim Läuger](https://github.com/devsaurus) | [dac.c](../../../components/modules/dac.c)|
+| 2018-10-14 | [Arnim Läuger](https://github.com/devsaurus) | [Arnim Läuger](https://github.com/devsaurus) | [dac.c](../../components/modules/dac.c)|
 
 The DAC module provides access to the two built-in Digital to Analog Converters.
 

docs/en/modules/dht.md → docs/modules/dht.md

@@ -1,7 +1,7 @@
 # DHT Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2017-03-30 | [Arnim Läuger](https://github.com/devsaurus) | [Arnim Läuger](https://github.com/devsaurus) | [dht](../../../components/modules/dht.c)|
+| 2017-03-30 | [Arnim Läuger](https://github.com/devsaurus) | [Arnim Läuger](https://github.com/devsaurus) | [dht](../../components/modules/dht.c)|
 
 ## Constants
 Constants for various functions.

docs/en/modules/encoder.md → docs/modules/encoder.md

@@ -1,7 +1,7 @@
 # encoder Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2016-02-26 | [Terry Ellison](https://github.com/TerryE) | [Terry Ellison](https://github.com/TerryE) | [encoder.c](../../../app/modules/encoder.c)|
+| 2016-02-26 | [Terry Ellison](https://github.com/TerryE) | [Terry Ellison](https://github.com/TerryE) | [encoder.c](../../app/modules/encoder.c)|
 
 The encoder modules provides various functions for encoding and decoding byte data.
 

docs/en/modules/file.md → docs/modules/file.md

@@ -1,7 +1,7 @@
 # file Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [file.c](../../../components/modules/file.c)|
+| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [file.c](../../components/modules/file.c)|
 
 The file module provides access to the file system and its individual files.
 

docs/en/modules/gpio.md → docs/modules/gpio.md

@@ -1,7 +1,7 @@
 # GPIO Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2016-11-26 | [Johny Mattsson](https://github.com/jmattsson) | [Johny Mattsson](https://github.com/jmattsson) | [gpio.c](../../../components/modules/gpio.c)|
+| 2016-11-26 | [Johny Mattsson](https://github.com/jmattsson) | [Johny Mattsson](https://github.com/jmattsson) | [gpio.c](../../components/modules/gpio.c)|
 
 
 This module provides access to the [GPIO](https://en.wikipedia.org/wiki/General-purpose_input/output) (General Purpose Input/Output) subsystem.

docs/en/modules/http.md → docs/modules/http.md

@@ -1,7 +1,7 @@
 # HTTP Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2018-10-27 | [Tom Sutcliffe](https://github.com/tomsci) | [Tom Sutcliffe](https://github.com/tomsci) | [http.c](../../../components/modules/http.c)|
+| 2018-10-27 | [Tom Sutcliffe](https://github.com/tomsci) | [Tom Sutcliffe](https://github.com/tomsci) | [http.c](../../components/modules/http.c)|
 
 HTTP *client* module that provides an interface to do GET/POST/PUT/DELETE over HTTP and HTTPS, as well as customized requests. It can support large requests with an API similar to that of the `net` module. Multiple concurrent HTTP requests are supported. Both synchronous and asynchronous modes are supported.
 

docs/en/modules/i2c.md → docs/modules/i2c.md

@@ -1,7 +1,7 @@
 # I²C Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [i2c.c](../../../app/modules/i2c.c)|
+| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [i2c.c](../../app/modules/i2c.c)|
 
 This module supports different interfaces for communicating via I²C protocol. All interfaces can be assigned to arbitrary GPIOs for SCL and SDA and can be operated concurrently.
 

docs/en/modules/i2s.md → docs/modules/i2s.md

@@ -1,7 +1,7 @@
 # I2S Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2017-04-29 | zelll | [Arnim Läuger](https://github.com/devsaurus) | [i2s.c](../../../components/modules/i2s.c)|
+| 2017-04-29 | zelll | [Arnim Läuger](https://github.com/devsaurus) | [i2s.c](../../components/modules/i2s.c)|
 
 The I2S module provides access to the in-built two I2S controllers.
 

docs/en/modules/ledc.md → docs/modules/ledc.md

@@ -1,7 +1,7 @@
 # LEDC Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2017-07-05 | [Lars Stenberg](https://github.com/larsstenberg) | [Lars Stenberg](https://github.com/larsstenberg) | [ledc.c](../../../components/modules/ledc.c)|
+| 2017-07-05 | [Lars Stenberg](https://github.com/larsstenberg) | [Lars Stenberg](https://github.com/larsstenberg) | [ledc.c](../../components/modules/ledc.c)|
 
 
 This module provides access to the [LEDC](http://esp-idf.readthedocs.io/en/latest/api-reference/peripherals/ledc.html) PWM driver.

docs/en/modules/mqtt.md → docs/modules/mqtt.md

@@ -1,7 +1,7 @@
 # MQTT Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2018-10-08 | [Tuan PM](https://github.com/tuanpmt/esp_mqtt), [Espressif](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/protocols/mqtt.html) | | [mqtt.c](../../../components/modules/mqtt.c)|
+| 2018-10-08 | [Tuan PM](https://github.com/tuanpmt/esp_mqtt), [Espressif](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/protocols/mqtt.html) | | [mqtt.c](../../components/modules/mqtt.c)|
 
 The client supports version 3.1 and 3.1.1 of the [MQTT](https://en.wikipedia.org/wiki/MQTT) protocol. Make sure that the correct version is set with `make menuconfig` -> "Component config" -> "ESP-MQTT Configurations" -> "Enable MQTT protocol 3.1.1".
 

docs/en/modules/net.md → docs/modules/net.md

@@ -1,7 +1,7 @@
 # net Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2014-12-22 | [PhoeniX](https://github.com/djphoenix) | [Johny Mattsson](https://github.com/jmattsson), [Arnim Läuger](https://github.com/devsaurus) | [net.c](../../../components/modules/net.c)|
+| 2014-12-22 | [PhoeniX](https://github.com/djphoenix) | [Johny Mattsson](https://github.com/jmattsson), [Arnim Läuger](https://github.com/devsaurus) | [net.c](../../components/modules/net.c)|
 
 ## Constants
 Constants to be used in other functions: `net.TCP`, `net.UDP`

docs/en/modules/node.md → docs/modules/node.md

@@ -1,7 +1,7 @@
 # node Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [node.c](../../../app/modules/node.c)|
+| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [node.c](../../app/modules/node.c)|
 
 The node module provides access to system-level features such as sleep, restart and various info and IDs.
 

docs/en/modules/ow.md → docs/modules/ow.md

@@ -1,7 +1,7 @@
 # 1-Wire Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [ow.c](../../../components/modules/ow.c)|
+| 2014-12-22 | [Zeroday](https://github.com/funshine) | [Zeroday](https://github.com/funshine) | [ow.c](../../components/modules/ow.c)|
 
 This module provides functions to work with the [1-Wire](https://en.wikipedia.org/wiki/1-Wire) device communications bus system.
 

docs/en/modules/qrcodegen.md → docs/modules/qrcodegen.md

@@ -1,7 +1,7 @@
 # QR Code Generator Module
 | Since  | Origin / Contributor  | Maintainer  | Source  |
 | :----- | :-------------------- | :---------- | :------ |
-| 2018-10-20 | https://github.com/nayuki/QR-Code-generator.git integrated by [Tom Sutcliffe](https://github.com/tomsci) | [Tom Sutcliffe](https://github.com/tomsci) | [qrcodegen.c](../../../components/modules/qrcodegen.c)|
+| 2018-10-20 | https://github.com/nayuki/QR-Code-generator.git integrated by [Tom Sutcliffe](https://github.com/tomsci) | [Tom Sutcliffe](https://github.com/tomsci) | [qrcodegen.c](../../components/modules/qrcodegen.c)|
 
 This module wraps the [QR Code](https://en.wikipedia.org/wiki/QR_code) Generator API written in C by https://github.com/nayuki/QR-Code-generator.git for producing a QR Code.