Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Surface improvements to tutorials on the website more quickly #81

Closed
zeke opened this issue Sep 11, 2017 · 1 comment
Closed

Surface improvements to tutorials on the website more quickly #81

zeke opened this issue Sep 11, 2017 · 1 comment

Comments

@zeke
Copy link
Contributor

zeke commented Sep 11, 2017

Problem

The website currently displays docs from the latest stable version of Electron. The stable version doesn't change very often, and sometimes there are weeks of beta versions before the next stable bump.

While it makes sense for the website's API documentation to strictly match the current stable version of Electron, the tutorial content found in docs/tutorial is generally not Electron-version-specific.

Currently we fetch all docs from latest:

Files Source Commitish
/docs/**/*.md electron@latest
locale.yml electron.atom.io#master

Instead, I propose that we fetch docs/tutorial/** straight from Electron's master branch:

Files Source Commitish
/docs/api/**/*.md electron@latest
/docs/development/**/*.md electron@latest
/docs/tutorial/**/*.md electron#master
locale.yml electron.atom.io#master

cc @leo, whose eagerness to see electron/electron#10251 deployed on the website prompted this idea.

@leo
Copy link

leo commented Sep 12, 2017

Very good idea! 👍😊

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants