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

Merge pull request #7264 from electron/docs-readme

Browse source 
Docs Readme
This commit is contained in:
Cheng Zhao 2016-09-20 14:31:31 +09:00 • committed by GitHub
commit 143d7ab98f
1 changed files with 7 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/README.md
View file

@ -1,15 +1,15 @@
Please make sure that you use the documents that match your Electron version. Please make sure that you use the documents that match your Electron version.
The version number should be a part of the page URL. If it's not, you are The version number should be a part of the page URL. If it's not, you are
probably using the documentation of a development branch which may contain API probably using the documentation of a development branch which may contain API
changes that are not compatible with your Electron version. If that's the case, changes that are not compatible with your Electron version. To view older
you can switch to a different version of the documentation at the versions of the documentation, you can
[available versions](http://electron.atom.io/docs/) list on atom.io, or if [browse by tag](https://github.com/electron/electron/tree/v1.4.0)
you're using the GitHub interface, open the "Switch branches/tags" dropdown and on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag
select the tag that matches your version. that matches your version.
## FAQ ## FAQ
There are questions that are asked quite often, check this out before creating There are questions that are asked quite often. Check this out before creating
an issue: an issue:
* [Electron FAQ](faq.md) * [Electron FAQ](faq.md)
@ -97,3 +97,4 @@ an issue:
* [Debug Instructions (macOS)](development/debug-instructions-macos.md) * [Debug Instructions (macOS)](development/debug-instructions-macos.md)
* [Debug Instructions (Windows)](development/debug-instructions-windows.md) * [Debug Instructions (Windows)](development/debug-instructions-windows.md)
* [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md) * [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md)
* [Documentation Styleguide](development/styleguide.md)