build: pre-build script #3
Conversation
molant
force-pushed
the
feat/pre-build
branch
2 times, most recently
from
e16a936
to
8dbbed4
Compare
The pre-build scripts does the following: 1. Downloads the documentation from electron/electron and data/blog from electron/electronjs.org 2. Moves the files to the right folders based on the contents of `docs-reorg.json` 3. Add frontmatter to each file 4. Fixes internal links and multiline image titles 5. Generates the sidebar using the folder structure - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Fix #6 Ref: Solves parts of #2
| "request": "launch", | ||
| "name": "Launch Program", | ||
| "skipFiles": ["<node_internals>/**"], | ||
| "program": "${workspaceFolder}/scripts/pre-build.js", |
There was a problem hiding this comment.
Do we need this version controlled?
There was a problem hiding this comment.
I'd keep it in case someone else in the future wants to debug using vs code so they don't have to create it, although I should change the name.
| @@ -0,0 +1,80 @@ | |||
| { | |||
| "docs/experimental.md": "docs/api/experimental.md", | |||
There was a problem hiding this comment.
This is a non-blocking comment, but I'm wondering if re-organizing the contents of the /docs folder is truly necessary for our purposes. Doing this will break existing URLs, and is not necessary for the sidebar configuration.
I guess it would make navigating through the docs on GitHub a bit easier?
There was a problem hiding this comment.
is truly necessary for our purposes.
My preference would be to have the content reorganization upstream so developers have an easier way finding things and knowing where things should go. If we don't use the paths, then we will have to force contributors to use a particular property in frontmatter indicating the category.
Doing this will break existing URLs,
Maybe we can look at the current analytics and see how much direct traffic goes to those pages. If it's significant we can probably create a redirect . TBH, I'd rather have something meaningful in the URL than putting everything under tutorial:
I guess it would make navigating through the docs on GitHub a bit easier?
Once we upstream the new location it should make it easier to navigate and to contribute.
The pre-build scripts does the following:
from electron/electronjs.org
docs-reorg.jsonRef: Solves parts of #2