Update README to explain how to view changes to public docs

pganalyze · May 10, 2024 · 2667129 · 2667129
1 parent 9c252b1
commit 2667129
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,13 @@ Here you can find the source for the documentation for pganalyze - PostgreSQL Pe
 
 See also https://pganalyze.com/docs
 
+## Contributing
+
+To visualize changes to the public documentation:
+- checkout the [pganalyze-web](https://github.com/pganalyze/pganalyze-web) repo
+- update its `docs` submodule to include your changes
+- in the web repo, run `yarn run gatsby develop`
+
 ## Copyright
 
 Copyright 2018, Duboce Labs Inc.