fix: add comment

bob-collective · Nov 25, 2023 · 033d654 · 033d654
1 parent 0582502
commit 033d654
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/python_script/refactor_doc.py → docs_reformat_scripts/forge_doc_reformat.py b/python_script/refactor_doc.py → docs_reformat_scripts/forge_doc_reformat.py
@@ -1,3 +1,9 @@
+"""
+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.
+Therefore, run this script before publishing the doc to make it compatible with Docusaurus.
+"""
+
 import os
 import re