how to update config docs

bcdev · Sep 14, 2024 · c5270c5 · c5270c5
1 parent 9297271
commit c5270c5
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -29,7 +29,11 @@ checklist are addressed in your PR.
   Use `pytest --cov=zappend --cov-report=html` to verify.
 * If your change affects the current project documentation,
   please adjust it and include the change in the PR.
-  Run `mkdocs serve` to verify.
+  Run `mkdocs serve` to verify. 
+* The configuration reference `docs/config.md` is generated.
+  Therefore, if you modify the `zappend` configuration, 
+  regenerate docs by `zappend --help-config md > docs/config.md`
+  and verify the output.
 
 ## Code style