Merge pull request #3535 from etiktin/use_the_correct_docs_version
Use the correct docs version
This commit is contained in:
commit
812e105d4f
4 changed files with 37 additions and 5 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -1,4 +1,5 @@
|
|||
.DS_Store
|
||||
.tags*
|
||||
/.idea/
|
||||
/build/
|
||||
/dist/
|
||||
|
|
|
@ -76,7 +76,11 @@
|
|||
};
|
||||
</script>
|
||||
|
||||
<h2 style="-webkit-app-region: drag">Welcome to Electron</h2>
|
||||
<h2>
|
||||
<script>
|
||||
document.write(`Welcome to Electron (v${process.versions.electron})`)
|
||||
</script>
|
||||
</h2>
|
||||
|
||||
<p>
|
||||
To run your app with Electron, execute the following command under your
|
||||
|
@ -87,8 +91,18 @@
|
|||
|
||||
<p>
|
||||
The <code>path-to-your-app</code> should be the path to your own Electron
|
||||
app, you can read the <a href='https://github.com/atom/electron/blob/master/docs/tutorial/quick-start.md'>quick start</a>
|
||||
guide in Electron's <a href='https://github.com/atom/electron/blob/master/docs'>docs</a>
|
||||
app, you can read the
|
||||
<script>
|
||||
document.write(
|
||||
`<a href='https://github.com/atom/electron/blob/v${process.versions.electron}/docs/tutorial/quick-start.md'>quick start</a>`
|
||||
);
|
||||
</script>
|
||||
guide in Electron's
|
||||
<script>
|
||||
document.write(
|
||||
`<a href='https://github.com/atom/electron/tree/v${process.versions.electron}/docs#readme'>docs</a>`
|
||||
);
|
||||
</script>
|
||||
on how to write one.
|
||||
</p>
|
||||
|
||||
|
|
|
@ -148,7 +148,11 @@ app.once('ready', function() {
|
|||
},
|
||||
{
|
||||
label: 'Documentation',
|
||||
click: function() { shell.openExternal('https://github.com/atom/electron/tree/master/docs#readme') }
|
||||
click: function() {
|
||||
shell.openExternal(
|
||||
`https://github.com/atom/electron/tree/v${process.versions.electron}/docs#readme`
|
||||
)
|
||||
}
|
||||
},
|
||||
{
|
||||
label: 'Community Discussions',
|
||||
|
@ -249,7 +253,11 @@ if (option.file && !option.webdriver) {
|
|||
} catch(e) {
|
||||
if (e.code == 'MODULE_NOT_FOUND') {
|
||||
app.focus();
|
||||
dialog.showErrorBox('Error opening app', 'The app provided is not a valid electron app, please read the docs on how to write one:\nhttps://github.com/atom/electron/tree/master/docs\n\n' + e.toString());
|
||||
dialog.showErrorBox(
|
||||
'Error opening app',
|
||||
'The app provided is not a valid Electron app, please read the docs on how to write one:\n' +
|
||||
`https://github.com/atom/electron/tree/v${process.versions.electron}/docs\n\n${e.toString()}`
|
||||
);
|
||||
process.exit(1);
|
||||
} else {
|
||||
console.error('App threw an error when running', e);
|
||||
|
|
|
@ -1,3 +1,12 @@
|
|||
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
|
||||
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,
|
||||
you can switch to a different version of the documentation at the
|
||||
[available versions](http://electron.atom.io/docs/) list on atom.io, or if
|
||||
you're using the GitHub interface, open the "Switch branches/tags" dropdown and
|
||||
select the tag that matches your version.
|
||||
|
||||
## Guides
|
||||
|
||||
* [Supported Platforms](tutorial/supported-platforms.md)
|
||||
|
|
Loading…
Reference in a new issue