mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Add a note to readme about docs versioning

Browse source 
Added a note to readme about using the correct docs version. Hopefully
this will reduce users confusion.
This commit is contained in:
Eran Tiktin 2015-11-21 03:31:52 +02:00
parent 4d4bb0a73e
commit 5730d588d0
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/README.md
View file

@ -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 ## Guides
* [Supported Platforms](tutorial/supported-platforms.md) * [Supported Platforms](tutorial/supported-platforms.md)