Troubleshooting Documentation Errors
React Hook Errors
If you have installed the dependencies in the root of the Medusa repository (that is, if you have a node_modules
Copy to Clipboard directory at the root of the Medusa repository), this will cause an error when running the documentation website.
This is because the content resides in docs/content
Copy to Clipboard. When that content is being imported from there, a mix up can happen between the dependencies in the root of the Medusa repository and the dependencies in www/docs
Copy to Clipboard which causes an invalid hook call
Copy to Clipboard error.
For that reason, when the start
Copy to Clipboard and build
Copy to Clipboard scripts in www/docs
Copy to Clipboard are used, the clean-node-modules
Copy to Clipboard script is called. This script deleted the node_modules
Copy to Clipboard directory in the root of the Medusa repository.
Out of Memory Error
If you receive the following error when you run the build
Copy to Clipboard command in www/docs
Copy to Clipboard:
FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory
This is because of an ongoing issue in Docusaurus that occurs in large documentation websites. As it is still not resolved, the workaround would be to change the memory limit for Node.js while running the build
Copy to Clipboard command.
To do that, run the build
Copy to Clipboard command with the NODE_OPTIONS
Copy to Clipboard environment variable set: