Skip to content

Commit

Permalink
Migrate to shortestpathlab
Browse files Browse the repository at this point in the history
  • Loading branch information
spaaaacccee committed May 17, 2024
1 parent b26403f commit 1b99cb7
Show file tree
Hide file tree
Showing 11 changed files with 26 additions and 28 deletions.
10 changes: 5 additions & 5 deletions blog/2023-09-22-changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,19 +148,19 @@ This example compares the search process of two A\* implementations, one as a Se

Get Posthoc as a standalone application for Windows.

[View Releases](https://github.com/path-visualiser/app/releases)
[View Releases](https://github.com/ShortestPathLab/posthoc-app/releases)

#### Posthoc Standalone (Electron) for Linux

Get Posthoc as a standalone application for Linux.

[View Releases](https://github.com/path-visualiser/app/releases)
[View Releases](https://github.com/ShortestPathLab/posthoc-app/releases)

#### Posthoc PWA (Github Pages)

Use Posthoc in your browser, or install it as a web app.

[Open Posthoc](https://path-visualiser.github.io/app/)
[Open Posthoc](https://posthoc-app.pathfinding.ai/)

#### Warthog (WebAssembly) Solver Adapter

Expand All @@ -173,7 +173,7 @@ This is the Warthog solver compiled to WebAssembly. Add this URL as a **Web Work
This is the Warthog solver running behind an adapter server. The adapter translates requests into Warthog problem instances, and converts Warthog output into the search trace format. The visualiser and solver communicates through a WebSocket channel.

```shell
git clone https://github.com/path-visualiser/app
git clone https://github.com/ShortestPathLab/posthoc-app
cd ./app/adapter-warthog-websocket
npm i
npm start
Expand All @@ -186,7 +186,7 @@ Then, as prompted, add the server's URL as a **Socket.io** connection in Posthoc
This is an example adapter that exclusively serves iron harvest grid maps to demonstrate how you could serve maps as well as run search queries.

```shell
git clone https://github.com/path-visualiser/app
git clone https://github.com/ShortestPathLab/posthoc-app
cd ./app/adapter-iron-harvest
npm i
npm start
Expand Down
4 changes: 2 additions & 2 deletions blog/2024-03-01-changelog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ We slightly improved perceived performance by increasing resolution when playbac

# Known Issues

See issues on [our bug tracker](https://github.com/path-visualiser/app/issues).
See issues on [our bug tracker](https://github.com/ShortestPathLab/posthoc-app/issues).

# Releases

See releases for v1.2.0 [here](https://github.com/path-visualiser/app/releases/tag/v1.2.0).
See releases for v1.2.0 [here](https://github.com/ShortestPathLab/posthoc-app/releases/tag/v1.2.0).
2 changes: 1 addition & 1 deletion docs/0-get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import imageC from "./image-9.png";

We're excited to have you here. 😊

Posthoc is a way to build quick-and-dirty visualisations ✨ for sequential decision-making algorithms, such as search algorithms. Just print logs as [search traces](./search-trace) and drop those into the [Posthoc visualiser](./visualiser/overview).
Posthoc is a way to build simple and effective visualisations ✨ for sequential decision-making algorithms, such as search algorithms. Just print logs as [search traces](./search-trace) and drop those into the [Posthoc visualiser](./visualiser/overview).

<Stack direction="row" sx={{ ...grid(360), gap: 2, mb: 4 }}>
<Card
Expand Down
4 changes: 2 additions & 2 deletions docs/1-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Overview

**Posthoc** is a way to build quick-and-dirty visualisations ✨ for sequential decision-making algorithms, such as search algorithms 🚀.
**Posthoc** is a way to build simple and effective visualisations ✨ for sequential decision-making algorithms, such as search algorithms 🚀.

![Alt text](overview.png)

Expand Down Expand Up @@ -66,4 +66,4 @@ Building visualisations is a lot of effort; we want to focus on writing and perf

Posthoc adds visualisation to our problem-solving toolkit 🛠️.

When problems occur in a spatial environment &mdash; navigating through roads, corridors, terrain etc &mdash; it's just natural to reason about them visually. Posthoc lets us create quick-and-dirty visualisations to leverage intuition, debug problems, draw insights, and collaborate with each other.
When problems occur in a spatial environment &mdash; navigating through roads, corridors, terrain etc &mdash; it's just natural to reason about them visually. Posthoc lets us create simple and effective visualisations to leverage intuition, debug problems, draw insights, and collaborate with each other.
4 changes: 2 additions & 2 deletions docs/2-search-trace.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Search traces should have the extensions `.trace.yaml` or `.trace.json`.

## Creating search traces

Search traces are zero-configuration to get started. Log events via print statements. Copy and paste those into a file, and chuck that into [Posthoc](./visualiser/overview). Quick-and-dirty's the spirit!
Search traces are zero-configuration to get started. Log events via print statements. Copy and paste those into a file, and chuck that into [Posthoc](./visualiser/overview). simple and effective's the spirit!

```cpp
cout << "- { type: " << type << ", id: " << id << "}"
Expand Down Expand Up @@ -199,7 +199,7 @@ Control when elements should be cleared.

| Value | Usage | Description |
| ----------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `false` (default) | `clear: false` | Event remains visible until the end of the search trace. drawn. |
| `false` (default) | `clear: false` | Event remains visible until the end of the search trace. |
| `true` | `clear: true` | Event clears immediately after the step they're drawn. |
| `string` | `clear: close` | Event remains visible until another event of the same `id`, and the specified type (e.g. `close`), is encountered. This can also be an expression that evaluates to a string. |

Expand Down
8 changes: 4 additions & 4 deletions docs/3-visualiser/3-1-user-guide/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Adapters implement the [Visualiser Adapter Protocol](/docs/visualiser-adapter-pr

### Other adapters

| Name | URL | Connection Type | Description |
| --------------------- | -------------------------------------------------------------------------------------------- | --------------- | ------------------------------------ |
| Warthog (WebAssembly) | `https://cdn.jsdelivr.net/gh/path-visualiser/app@adapter-warthog-wasm-dist/warthog-wasm.mjs` | Web Worker | Solver adapter for Warthog & Roadhog |
| Name | URL | Connection Type | Description |
| --------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------- | ------------------------------------ |
| Warthog (WebAssembly) | `https://cdn.jsdelivr.net/gh/ShortestPathLab/posthoc-adapter-warthog@adapter-warthog-wasm-dist/warthog-wasm.mjs` | Web Worker | Solver adapter for Warthog & Roadhog |

[You can find more adapters here.](https://github.com/path-visualiser/app)
[You can find more adapters here.](https://github.com/ShortestPathLab/posthoc-app)

## Renderers

Expand Down
2 changes: 1 addition & 1 deletion docs/3-visualiser/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ sidebar_position: 4

# Contributing

We welcome new issues, discussions, and PRs on our [Github repository](https://github.com/path-visualiser/app).
We welcome new issues, discussions, and PRs on our [Github repository](https://github.com/ShortestPathLab/posthoc-app).

Check out our roadmap [here](https://github.com/orgs/path-visualiser/projects/2/views/2).
2 changes: 1 addition & 1 deletion docs/3-visualiser/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Optionally, you can [install Posthoc as a web app](https://developer.mozilla.org

### Standalone builds

Check the [releases](https://github.com/path-visualiser/app/releases) page for a list of latest Windows and Linux releases. They work exactly the same as the web version, but you can get access to older versions of Posthoc.
Check the [releases](https://github.com/ShortestPathLab/posthoc-app/releases) page for a list of latest Windows and Linux releases. They work exactly the same as the web version, but you can get access to older versions of Posthoc.
2 changes: 1 addition & 1 deletion docs/4-visualiser-adapter-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The **Visualiser Adapter Protocol** connects solvers directly to the visualiser

**Visualiser Adapter Protocol** goes beyond simple solution-based visualisations. It allows visualisers to interactively run queries on solvers, and solvers to return expressive visualisations as search traces, to help you understand, debug, and experiment with your code.

This API is yet to be finalised. The definition for the current version of this protocol is available [here](https://github.com/path-visualiser/app/blob/master/protocol/index.ts), but expect large changes soon.
This API is yet to be finalised. The definition for the current version of this protocol is available [here](https://github.com/ShortestPathLab/posthoc-app/blob/master/protocol/index.ts), but expect large changes soon.

:::warning
This section is incomplete.
Expand Down
14 changes: 6 additions & 8 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ const config: Config = {
titleDelimiter: "-",

// Set the production url of your site here
url: "https://path-visualiser.github.io",
url: "https://posthoc.pathfinding.ai",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "path-visualiser", // Usually your GitHub org/user name.
organizationName: "ShortestPathLab", // Usually your GitHub org/user name.
projectName: "docs", // Usually your repo name.

onBrokenLinks: "warn",
Expand All @@ -38,15 +38,13 @@ const config: Config = {
sidebarPath: "./sidebars.ts",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
"https://github.com/path-visualiser/path-visualiser.github.io/tree/master",
editUrl: "https://github.com/ShortestPathLab/posthoc/tree/master",
},
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
"https://github.com/path-visualiser/path-visualiser.github.io/tree/master",
editUrl: "https://github.com/ShortestPathLab/posthoc/tree/master",
},
// blog: {
// showReadingTime: true,
Expand Down Expand Up @@ -79,12 +77,12 @@ const config: Config = {
},
{ to: "/blog", label: "Blog", position: "left" },
{
href: "https://path-visualiser.github.io/app",
href: "https://posthoc-app.pathfinding.ai",
label: "Open Posthoc",
position: "right",
},
{
href: "https://github.com/path-visualiser/app",
href: "https://github.com/ShortestPathLab/posthoc-app",
label: "Github",
position: "left",
},
Expand Down
2 changes: 1 addition & 1 deletion src/pages/en-au.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
}
],
"heroTitle": "Explore decision-making in search",
"heroSubtitle": "Posthoc is a way to create quick-and-dirty visualisations from logs to help you understand search.",
"heroSubtitle": "Posthoc is a way to create simple and effective visualisations from logs to help you understand search.",
"heroCallToAction": "Get started",
"heroCallToActionUrl": "./docs/get-started",
"endCallToActionTitle": "Ready to try Posthoc?",
Expand Down

0 comments on commit 1b99cb7

Please sign in to comment.