From 0271c7ded8ac9c18d4629bbf4c5cc1b7f54e864a Mon Sep 17 00:00:00 2001 From: Matthew Tancik Date: Fri, 11 Nov 2022 08:58:53 -0800 Subject: [PATCH] Update docs (#944) --- docs/developer_guides/viewer/viewer_overview.md | 16 ++++++++-------- docs/index.md | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/developer_guides/viewer/viewer_overview.md b/docs/developer_guides/viewer/viewer_overview.md index bd2d33e4d..2e47a67e2 100644 --- a/docs/developer_guides/viewer/viewer_overview.md +++ b/docs/developer_guides/viewer/viewer_overview.md @@ -22,14 +22,6 @@ The connection between the Bridge Server and the Client App works with WebSocket ## Installing and running locally -#### Running the Bridge Server - -The viewer bridge server runs on the same machine that you use for training. The training code will connect to this server with a lightweight TCP connection using ZMQ. The training job will launch the viewer bridge server is you specify `--viewer.launch-bridge-server` in the terminal. Otherwise, you can launch the bridge server manually with the following script. - -```python -python scripts/viewer/run_bridge_server.py --help -``` - #### Running the Client App ```shell @@ -58,6 +50,14 @@ yarn install yarn start ``` +#### Running the Bridge Server Manually + +The viewer bridge server runs on the same machine that you use for training. The training code will connect to this server with a lightweight TCP connection using ZMQ. The training job will launch the viewer bridge server is you specify `--viewer.launch-bridge-server` in the terminal. Otherwise, you can launch the bridge server manually with the following script. + +```python +python scripts/viewer/run_bridge_server.py --help +``` + ## Acknowledgements and references We thank the authors and contributors to the following repos, which we've started, used, and modified for our use-cases. diff --git a/docs/index.md b/docs/index.md index db68182d2..69b149711 100644 --- a/docs/index.md +++ b/docs/index.md @@ -105,7 +105,7 @@ We'll be constantly growing this list! So make sure to check back in to see our | | | | ---------------------------------------------------------- | ---------------------- | | [Github](https://github.com/nerfstudio-project/nerfstudio) | Official Github Repo | -| [Discord](https://discord.com/invite/NHGtYRAW) | Join Discord Community | +| [Discord](https://discord.gg/RyVk6w5WWP) | Join Discord Community | | [Viewer](https://viewer.nerf.studio/) | Web-based Nerf Viewer | ### How-to Videos