Figure out how to enable fast docs development locally #4
Labels
✨ enhancement
New feature or request
Comments
molant
added a commit
that referenced
this issue
Apr 22, 2021
This PR allows developers to pass a parameter to indicate where in the file system the `prebuild` script should look for the documentation. It assumes it is a clone of `electron/electron` so the content should be under a `/docs` folder. E.g.: ```console yarn prebuild ../electron ``` In the future there might be a `watch` option enabled by default. This is the MVP for #4. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Fix #4
molant
added a commit
that referenced
this issue
Apr 22, 2021
This PR allows developers to pass a parameter to indicate where in the file system the `prebuild` script should look for the documentation. It assumes it is a clone of `electron/electron` so the content should be under a `/docs` folder. E.g.: ```console yarn prebuild ../electron ``` In the future there might be a `watch` option enabled by default. This is the MVP for #4. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Fix #4
molant
added a commit
that referenced
this issue
Apr 26, 2021
This PR allows developers to pass a parameter to indicate where in the file system the `prebuild` script should look for the documentation. It assumes it is a clone of `electron/electron` so the content should be under a `/docs` folder. E.g.: ```console yarn prebuild ../electron ``` In the future there might be a `watch` option enabled by default. This is the MVP for #4. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Fix #4
molant
added a commit
that referenced
this issue
Apr 26, 2021
This PR allows developers to pass a parameter to indicate where in the file system the `prebuild` script should look for the documentation. It assumes it is a clone of `electron/electron` so the content should be under a `/docs` folder. E.g.: ```console yarn prebuild ../electron ``` In the future there might be a `watch` option enabled by default. This is the MVP for #4. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Fix #4 Close #9
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
One of the problems with the current way we have docs is that it's really complicated to see how any changes to the documentation look like in the website:
electron/electronelectron/i18nget updated periodically and pushed to crowdinelectron-i18nis publishedelectron/electronjs.orgthen picks that the package has been updated and when the change is merged it gets finally deployedWhile we still want the documentation to live in
electron/electron, we want contributors to have an easy way to see how the docs would look like in the website.Ref #2
The text was updated successfully, but these errors were encountered: