From 266712964d82a3155cf3e0671d6311ac9194cbb2 Mon Sep 17 00:00:00 2001 From: Sean Linsley Date: Fri, 10 May 2024 10:34:31 -0500 Subject: [PATCH] Update README to explain how to view changes to public docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 61ae6cc0..e8fa7852 100644 --- 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.