diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 3651756c40..2c61af69b0 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -432,6 +432,8 @@ The documentation site is built on ReadTheDocs. It will build a preview for each PR which is linked from the PR status. It's useful to take a look if you're changing any of the documentation. +Run `build-and-serve-docs` in nix-shell to host a local instance at http://0.0.0.0:8002/. Haddock is at http://0.0.0.0:8002/haddock. + ==== Github Actions These perform some of the same checks as Hydra, but Github Actions is often more available, so they return faster and act as a "smoke check". diff --git a/doc/README.md b/doc/README.md index 1ad7feb7b1..5173a1639c 100644 --- a/doc/README.md +++ b/doc/README.md @@ -22,6 +22,8 @@ Or you can use Nix which will also build the Haddock for the project and link it nix build -f default.nix docs.site ``` +Or you can run `build-and-serve-docs` in nix-shell to host a local instance of ReadTheDocs at http://0.0.0.0:8002/. Haddock is at http://0.0.0.0:8002/haddock. + The doc site from main is built automatically and hosted [here](https://plutus-apps.readthedocs.io/en/latest). Additionally, the site is built for all PRs, and a link to a preview can be found in the PR statuses.