Skip to content

Commit

Permalink
Partially wrote overview
Browse files Browse the repository at this point in the history
  • Loading branch information
spaaaacccee committed Nov 30, 2023
1 parent 579df66 commit 8518de9
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 2 deletions.
48 changes: 46 additions & 2 deletions docs/1-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,54 @@ sidebar_position: 1

# Overview

**Visualiser** is a visualiser and debugger for spatially-embedded algorithms, especially pathfinding search.

![Alt text](image.png)

Understanding how algorithms work can be hard. Luckily, pathfinding problems are often occur in have a spatial environment — navigating through roads, corridors, terrain etc. So, it's natural to reason about them visually. For these problems, rather than staring at `cout`/`print` logs or stepping through the code, it would make more sense to see them run in the context their respective environments.

What's more, Visualiser isn't just for pathfinding search. Visualiser is designed to visualise any sort of decision-making over a 2D or 3D space.

## What Can I Use Visualiser For?

### Insights

[TODO]

### Post-hoc Analysis

[TODO]

### Demonstrations

Creating visualisations are the best way to get your point across.

## What's So Cool About Visualiser?

### Declarative

Rather than writing your own visualiser, declaratively visualise your pathfinding search by creating _search traces_, YAML files that describe what happened during your algorithm, and how you want them to be drawn.

### Robust

[TODO]

### Extensible

[TODO]

## When Shouldn't I Use Visualiser?

### Not a Replacement for a Traditional Debugger

[TODO]

### Not For Plotting Graphs

[TODO]

:::warning

This site is under construction. Content may be inaccurate or missing.

:::

Visualiser is a visualiser for pathfinding search.
3 changes: 3 additions & 0 deletions docs/6-api/search-trace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Search Trace

## Context
1 change: 1 addition & 0 deletions docs/6-api/visualiser-adapter-protocol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Visualiser Adapter Protocol
Binary file added docs/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8518de9

Please sign in to comment.