From 5750da121c5bdf03b7cff12de8c0574226db6474 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Sun, 13 Jan 2019 21:19:03 +0100 Subject: [PATCH] Re-organize documentation Drop support for localized content, #2213 Restructure some content to match more closely what we have in master, #2542 --- docs/{en => }/build.md | 0 docs/{en => }/extn-developer-faq.md | 0 docs/{en => }/flash.md | 2 +- docs/index.md | 13 +-- docs/js/extra.js | 120 ++------------------------- docs/{en => }/lua-developer-faq.md | 0 docs/{en => }/modules/adc.md | 2 +- docs/{en => }/modules/bit.md | 2 +- docs/{en => }/modules/bthci.md | 2 +- docs/{en => }/modules/can.md | 2 +- docs/{en => }/modules/dac.md | 2 +- docs/{en => }/modules/dht.md | 2 +- docs/{en => }/modules/encoder.md | 2 +- docs/{en => }/modules/file.md | 2 +- docs/{en => }/modules/gpio.md | 2 +- docs/{en => }/modules/http.md | 2 +- docs/{en => }/modules/i2c.md | 2 +- docs/{en => }/modules/i2s.md | 2 +- docs/{en => }/modules/ledc.md | 2 +- docs/{en => }/modules/mqtt.md | 2 +- docs/{en => }/modules/net.md | 2 +- docs/{en => }/modules/node.md | 2 +- docs/{en => }/modules/ow.md | 2 +- docs/{en => }/modules/qrcodegen.md | 2 +- docs/{en => }/modules/sdmmc.md | 4 +- docs/{en => }/modules/sigma-delta.md | 2 +- docs/{en => }/modules/sjson.md | 4 +- docs/{en => }/modules/sodium.md | 2 +- docs/{en => }/modules/spi.md | 4 +- docs/{en => }/modules/struct.md | 2 +- docs/{en => }/modules/time.md | 2 +- docs/{en => }/modules/tmr.md | 2 +- docs/{en => }/modules/u8g2.md | 12 +-- docs/{en => }/modules/uart.md | 2 +- docs/{en => }/modules/ucg.md | 4 +- docs/{en => }/modules/wifi.md | 2 +- docs/{en => }/modules/ws2812.md | 4 +- docs/{en => }/sdcard.md | 2 +- docs/{en => }/support.md | 2 +- docs/{en => }/upload.md | 2 +- mkdocs.yml | 85 +++++++++---------- 41 files changed, 98 insertions(+), 210 deletions(-) rename docs/{en => }/build.md (100%) rename docs/{en => }/extn-developer-faq.md (100%) rename docs/{en => }/flash.md (98%) rename docs/{en => }/lua-developer-faq.md (100%) rename docs/{en => }/modules/adc.md (96%) rename docs/{en => }/modules/bit.md (97%) rename docs/{en => }/modules/bthci.md (98%) rename docs/{en => }/modules/can.md (95%) rename docs/{en => }/modules/dac.md (93%) rename docs/{en => }/modules/dht.md (96%) rename docs/{en => }/modules/encoder.md (95%) rename docs/{en => }/modules/file.md (99%) rename docs/{en => }/modules/gpio.md (99%) rename docs/{en => }/modules/http.md (99%) rename docs/{en => }/modules/i2c.md (98%) rename docs/{en => }/modules/i2s.md (98%) rename docs/{en => }/modules/ledc.md (99%) rename docs/{en => }/modules/mqtt.md (99%) rename docs/{en => }/modules/net.md (99%) rename docs/{en => }/modules/node.md (99%) rename docs/{en => }/modules/ow.md (98%) rename docs/{en => }/modules/qrcodegen.md (96%) rename docs/{en => }/modules/sdmmc.md (96%) rename docs/{en => }/modules/sigma-delta.md (98%) rename docs/{en => }/modules/sjson.md (97%) rename docs/{en => }/modules/sodium.md (98%) rename docs/{en => }/modules/spi.md (97%) rename docs/{en => }/modules/struct.md (99%) rename docs/{en => }/modules/time.md (99%) rename docs/{en => }/modules/tmr.md (98%) rename docs/{en => }/modules/u8g2.md (97%) rename docs/{en => }/modules/uart.md (98%) rename docs/{en => }/modules/ucg.md (99%) rename docs/{en => }/modules/wifi.md (99%) rename docs/{en => }/modules/ws2812.md (98%) rename docs/{en => }/sdcard.md (85%) rename docs/{en => }/support.md (97%) rename docs/{en => }/upload.md (98%) diff --git a/docs/en/build.md b/docs/build.md similarity index 100% rename from docs/en/build.md rename to docs/build.md diff --git a/docs/en/extn-developer-faq.md b/docs/extn-developer-faq.md similarity index 100% rename from docs/en/extn-developer-faq.md rename to docs/extn-developer-faq.md diff --git a/docs/en/flash.md b/docs/flash.md similarity index 98% rename from docs/en/flash.md rename to docs/flash.md index 2a16a249d8..f4d487495f 100644 --- a/docs/en/flash.md +++ b/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. \ No newline at end of file +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. diff --git a/docs/index.md b/docs/index.md index 96ba7c5a74..5a2072a7ac 100644 --- a/docs/index.md +++ b/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) diff --git a/docs/js/extra.js b/docs/js/extra.js index 7c00bfad3c..3a18ada82e 100644 --- a/docs/js/extra.js +++ b/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,75 +37,13 @@ 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. - //