Skip to content

Commit f5df83d

Browse files
authored
setup independent docs workflow (#473)
* setup independent docs workflow * ci docs
1 parent 47a2d99 commit f5df83d

File tree

16 files changed

+360
-98
lines changed

16 files changed

+360
-98
lines changed

docs/.gitignore

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
8+
9+
# Node dependencies
10+
node_modules
11+
12+
# Logs
13+
logs
14+
*.log
15+
16+
# Misc
17+
.DS_Store
18+
.fleet
19+
.idea
20+
.eslintcache
21+
22+
# Local env files
23+
.env
24+
.env.*
25+
!.env.example
26+
27+
# npm pack
28+
*.tgz
29+
30+
# Temp files
31+
.tmp
32+
.profile
33+
*.0x
34+
35+
#VSC
36+
.history
37+
.wrangler

docs/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Browzarr's documentation
2+
3+
## 🚀 Quick Start
4+
5+
```bash
6+
# Install dependencies
7+
npm install
8+
9+
# Start development server
10+
npm run dev
11+
```
12+
13+
Your documentation site will be running at `http://localhost:3000`
14+
15+
## 📖 Documentation
16+
17+
For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
18+
19+
## 🚀 Deployment
20+
21+
Build for production:
22+
23+
```bash
24+
npm run build
25+
```
26+
27+
The built files will be in the `.output` directory, ready for deployment to any hosting provider that supports Node.js.
28+
29+
## 📄 License
30+
31+
[MIT License](https://opensource.org/licenses/MIT)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
title: Getting Started
2+
icon: false
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Introduction
3+
description: Welcome to Browzarr's documentation.
4+
navigation:
5+
icon: i-lucide-soup
6+
seo:
7+
title: Introduction
8+
description: Welcome to Browzarr's documentation.
9+
---
10+
11+
Welcome to **Browzarr**'s documentation. Although, `browzarr.io` user's interface is pretty intuitive, there are plenty of features that deserve some dedicated space for a longer explanation. But first,
12+
13+
## What is Browzarr?
14+
15+
**Browzarr** is a powerful, browser-native framework for visualizing, exploring, and analyzing Zarr data stores.
16+
Load multi-dimensional datasets directly in the browser, interactively slice and inspect chunks, and gain insights without any backend or server setup.
17+
18+
19+
## Key Features
20+
21+
- **Data Cubes**
22+
- **Globe**
23+
- **Flat/rectangular Maps**
24+
-
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Landing
3+
description: User Interface.
4+
navigation:
5+
icon: i-lucide-plane-landing
6+
seo:
7+
description: User Interface.
8+
---
9+
10+
## Main menu
11+
12+
::steps
13+
### Stores
14+
15+
Use the `store` icon to load curated datasets or your own!
16+
17+
### Select a variable
18+
19+
From the menu `x` variables select the one you would like to see and click plot!
20+
21+
### Change plot type
22+
23+
There some default plotting options depending on your dataset dimensions, however you could change to a different plot type if your data dimensions allow it.
24+
25+
### A different Colormap
26+
27+
Hover the colormap options to see how your plot will change, then click on the one you like to setup that one!
28+
29+
### Settings
30+
31+
### Animation
32+
33+
### Analytics
34+
35+
::
36+
37+
## Floating menu
38+
39+
::prose-steps
40+
### Reset camera
41+
42+
Did you move around a lot? then click the reset camera icon.
43+
44+
### View
45+
46+
?
47+
48+
### 1D transects
49+
50+
Click to view 1D transects (line plots) through the given dimension.
51+
52+
### Export images and animations
53+
Do you want to use the output somewhere else? either has a static image or a video? we got you covered!
54+
55+
### Quality
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
title: Essentials
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Variable selection
3+
description: Select only data that fits.
4+
navigation:
5+
icon: i-lucide-variable
6+
---
7+
8+
## Variable Name
9+
10+
If not provided by metadata then is set to undefined.
11+
12+
### Attributes
13+
14+
Additional information about variables can be seeing by clicking on the attributes button.
15+
16+
17+
### Data Shape
18+
19+
It shows the overall data shape
20+
21+
### Chunk size
22+
If your variable is partitioned into chunks then here you will see the corresponding dimensions.
23+
24+
## Sliders
25+
If your data is too big then a set of slider for selection will be shown. Use those to select an appropriate range.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Colorbar
3+
description: Control bounds.
4+
navigation:
5+
icon: i-lucide-paint-bucket
6+
---
7+
8+
### Lower and upper bounds
9+
You can control the lower and upper bounds of your displayed data by clicking and typing different numbers in the input boxes (extreme left and right).
10+
11+
### Shift values
12+
13+
Dragging the colorbar itself will also shift the bound values.
14+
15+
### Attributes
16+
Clicking on the variable name (at the top of the colorbar) will also display their general attributes!
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Plot Settings
3+
description: Slice.
4+
navigation:
5+
icon: i-lucide-settings
6+
title: Plot settings
7+
---
8+
9+
WIP
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: Analytics
3+
description: Powered WebGPU analytics
4+
navigation:
5+
icon: i-lucide-brain
6+
seo:
7+
description: Powered WebGPU analytics
8+
---
9+
10+
## Powered WebGPU analytics

0 commit comments

Comments
 (0)