docs(v2): add a note for images not rendered on dev server #4164
Conversation
Add a note that images are not rendered on the development server
|
Hi @yuval-hazaz! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
|
[V1] Deploy preview success Built with commit 8786a33 |
|
Size Change: 0 B Total Size: 156 kB ℹ️ View Unchanged
|
|
Deploy preview for docusaurus-2 ready! Built with commit 8786a33 |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4164--docusaurus-2.netlify.app/classic/ |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
|
Hi, Should we really say that images do not render in the dev server? In practice, they do render, it's just you get the low-quality image placeholder. See for example on Docusaurus homepage in dev:
|
When the image is 100px originally and it is downsized to 15px you probably can understand that the image is there... in any case, any note with a more accurate explanation will also be great... just thinking of the next developer that will waste hours on finding out what is wrong. |
|
I don't argue that we should improve our doc and ensure users don't loose any time, just saying that the doc you want to add does not seem 100% accurate to me, so I just edited your words and will merge. We try to have good docs. FYI I just discovered this behavior that I was not even aware of (more context: https://v2.docusaurus.io/blog/2020/01/07/tribute-to-endi) |
slorber
changed the title
slorber
added
the
pr: documentation
|
OMG I just spent half a day trying to figure this one out until I stumbled upon this thread 😅 |
|
sorry about that 😓 |
|
haha no worries, all good. Once I'm done, RNN will have a shiny new showcase section just like the one Docusaurus has! :D |
Add a note that images are not rendered on the development server
Motivation
I spent more than an hour to finally find out that the images are not rendered on the development server. Although there is a message in the description saying "in the production builds." anyone can miss it easily.
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)