Organize wiki, make prettier

Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Point72 · Nov 22, 2024 · 9418c81 · 9418c81
1 parent 7ad2f67
commit 9418c81
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 45 deletions.
diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml
@@ -22,6 +22,9 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
+      - name: Make home file
+        run: cat README.md docs/wiki/_Home.md > docs/wiki/Home.md
 
       - name: Upload Documentation to Wiki
         uses: Andrew-Chen-Wang/github-wiki-action@v4

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ Ray offers powerful metrics visualizations powered by graphana and prometheus. A
 
 Raydar, enables out-of-the-box live cluster metrics and user visualizations for Ray workflows with just a simple pip install. It helps unlock distributed machine learning visualizations on Anyscale clusters, runs live and at scale, is easily customizable, and enables all the in-browser aggregations that [perspective](https://perspective.finos.org/) has to offer.
 
-![Example](docs/img/ml_example.gif)
+![Example](https://media.githubusercontent.com/media/Point72/raydar/refs/heads/main/docs/img/ml_example.gif)
 
 ## Features
 
@@ -31,19 +31,7 @@ Raydar, enables out-of-the-box live cluster metrics and user visualizations for
 
 ## Installation
 
-`raydar` can be installed via [pip](https://pip.pypa.io) or [conda](https://docs.conda.io/en/latest/), the two primary package managers for the Python ecosystem.
-
-To install `raydar` via **pip**, run this command in your terminal:
-
-```bash
-pip install raydar
-```
-
-To install `raydar` via **conda**, run this command in your terminal:
-
-```bash
-conda install raydar -c conda-forge
-```
+`raydar` can be installed via [pip](https://pip.pypa.io) or [conda](https://docs.conda.io/en/latest/), the two primary package managers for the Python ecosystem. See [our wiki](https://github.com/Point72/raydar/wiki/Installation) for more information.
 
 ## Launching The UI, Tracking Tasks, Creating/Updating Custom Tables
 
@@ -72,7 +60,7 @@ task_tracker.process(refs)
 
 The perspective UI is served on port 8000 by default.
 
-![Example](docs/img/example_perspective_dashboard.gif)
+![Example](https://media.githubusercontent.com/media/Point72/raydar/refs/heads/main/docs/img/example_perspective_dashboard.gif)
 
 Passing a `name` and `namespace` arguments allows the RayTaskTracker to skip construction when an actor already exists. This also means we can access the correct ray actor handle from arbitrary ray code, once the correct name and namespace are provided.
 
@@ -114,7 +102,7 @@ def add_data_to_demo_table(i):
     task_tracker.update_table("demo_table", [data])
 ```
 
-![Example](docs/img/custom_user_table.gif)
+![Example](https://media.githubusercontent.com/media/Point72/raydar/refs/heads/main/docs/img/custom_user_table.gif)
 
 ## FAQ
 
@@ -126,7 +114,7 @@ Currently, in memory. There are plans to integrate alternatives to this configur
 
 The `Save Layout` button saves a json file containing layout information. Dragging and dropping this file into the UI browser window restores that layout.
 
-![Example](docs/img/layout_restoration.gif)
+![Example](https://media.githubusercontent.com/media/Point72/raydar/refs/heads/main/docs/img/layout_restoration.gif)
 
 ## License
 

diff --git a/docs/wiki/API-Reference.md b/docs/wiki/API-Reference.md
diff --git a/docs/wiki/First-Steps.md b/docs/wiki/First-Steps.md
diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md
diff --git a/docs/wiki/Installation.md b/docs/wiki/Installation.md
@@ -1,6 +1,6 @@
 ## Pre-requisites
 
-You need Python >=3.8 on your machine to install `raydar`.
+`raydar` can be installed via [pip](https://pip.pypa.io) or [conda](https://docs.conda.io/en/latest/), the two primary package managers for the Python ecosystem. You need Python >=3.8 on your machine to install `raydar`.
 
 ## Install with `pip`
 

diff --git a/docs/wiki/Key-Features.md b/docs/wiki/Key-Features.md
@@ -1,3 +1,5 @@
+# Key Features
+
 ## Task Tracker
 
 The `raydar` module provides an actor which can process collections of ray object references on your behalf, and can serve a [perspective](https://github.com/finos/perspective) dashboard in which to visualize that data.

diff --git a/docs/wiki/_Home.md b/docs/wiki/_Home.md
@@ -0,0 +1,9 @@
+<!-- NOTE: top part of Home.md is README.md -->
+
+## Community
+
+- [Contribute](Contribute) to `raydar` and help improve the project
+
+> \[!TIP\]
+>
+> Find relevant docs with GitHub’s search function, use `repo:Point72/raydar type:wiki <search terms>` to search the documentation Wiki Pages.
diff --git a/docs/wiki/_Sidebar.md b/docs/wiki/_Sidebar.md
@@ -6,18 +6,13 @@ Notes for editors:
 - Use only the filenames in this page (without the filepath and file extension)
 -->
 
-**[Home](Home)**
+- [Home](Home)
 
 **Get Started**
 
 - [Installation](Installation)
-- [First steps](First-Steps)
 - [Key features](Key-Features)
 
-**References**
-
-- [API Reference](API-Reference)
-
 **Developer Guide**
 
 - [Contributing](Contribute)