From 5730d588d0debf86d25781d540c7e6c8aee5bb0d Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 21 Nov 2015 03:31:52 +0200 Subject: [PATCH] Add a note to readme about docs versioning Added a note to readme about using the correct docs version. Hopefully this will reduce users confusion. --- docs/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/README.md b/docs/README.md index 208ff8bf47b6..a1c8526e6ef5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,10 @@ +Please make sure that you use the documents that match your Electron version. +The version number should be a part of the URL. If it's not, you are probably +using the documentation of a development branch which may contain API changes +that are not compatible with your Electron version. +When in doubt, run Electron without supplying an app path, and click on the +`docs` link. + ## Guides * [Supported Platforms](tutorial/supported-platforms.md)