diff --git a/docs_reformat_scripts/forge_doc_reformat.py b/docs_reformat_scripts/forge_doc_reformat.py index b95d1dea..998bcf44 100644 --- a/docs_reformat_scripts/forge_doc_reformat.py +++ b/docs_reformat_scripts/forge_doc_reformat.py @@ -1,6 +1,6 @@ """ This Python script is designed to modify the Markdown files generated by the 'forge doc' command. -The 'forge doc' command doesn't return the docs in the right format for Docusaurus. +The 'forge doc --out docs/docs/contracts' command doesn't return the docs in the right format for Docusaurus. Therefore, run this script before publishing the doc to make it compatible with Docusaurus. """