[docs] generate code paths for webpack raw-loader efficiency #27301
Conversation
cmpadden
force-pushed
the
colton/generate-code-example-imports
branch
from
0914350 to
f10acb4
Compare
|
Deploy preview for dagster-docs-beta ready! Preview available at https://dagster-docs-beta-p8n9pgb1m-elementl.vercel.app Direct link to changed pages: |
| @@ -5,7 +5,7 @@ | |||
| "scripts": { | |||
| "docusaurus": "docusaurus", | |||
| "start": "docusaurus start -p 3050", | |||
| "build": "docusaurus build", | |||
| "build": "yarn generate-code-imports && docusaurus build", | |||
There was a problem hiding this comment.
do we also need to generate code imports before running yarn start ?
There was a problem hiding this comment.
yeah, I can add it there too! was a little worried about performance impact, but it would be a much better user experience.
Thanks for all the help Marco! 🙏 |
| //if (isServer) { | ||
| // const module = CODE_EXAMPLE_PATH_MAPPINGS[path]; | ||
| // processModule({cacheKey, module, lineStart, lineEnd, startAfter, endBefore}); | ||
| //} | ||
|
|
||
| if (!contentCache[cacheKey]) { |
There was a problem hiding this comment.
This means that docusaurus supports Suspense on the server!
There was a problem hiding this comment.
(the fact that we didn't need the isServer logic).
There was a problem hiding this comment.
should've probably removed that comment, whoops. Can do that in the future.
cmpadden
changed the title
Summary & Motivation
Edit looks like the regex is missing one of the entries as indicated by the failed Vercel build. Will look into this tomorrow.
raw-loaderwas previously scanning the entireexamples/folder, and leaving many artifacts. Resulting in excessive memory usage (see memory snapshot).This introduces a build step to create a mapping of
CodeExamplepaths to their correspondingimport, see improved memory snapshot.@salazarm we discussed this offline at some point, but would definitely appreciate your input on how this can be improved. Right off the bat, I'm not sure if the regex works for components that span multiple lines. Also want to get your input on if the server conditional logic is required. It seems to work with out it.
How I Tested These Changes
Changelog