Skip to content

Commit 16b18f8

Browse files
committed
Promote installation to navbar, clarify install path
Move /learn/00-installation to /install and add it as the first navbar item. Lead with pak::pak from GitHub since blockr is under heavy development; mention CRAN as fallback. Spell out that blockr is a meta-package that bundles core/dock/dag/dplyr/ggplot/io, and recommend blockr.session and blockr.bi for real applications. Point to the package overview as the source of truth for everything else.
1 parent 6726466 commit 16b18f8

4 files changed

Lines changed: 57 additions & 23 deletions

File tree

.vitepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ module.exports = {
1313
logo: { light: '/logos/logo-e4-light.svg', dark: '/logos/logo-e4-dark.svg' },
1414
siteTitle: 'blockr',
1515
nav: [
16+
{ text: 'Install', link: '/install' },
1617
{ text: 'Learn', link: '/learn/01-build-your-first-app' },
1718
{ text: 'Docs', link: '/docs/concepts/01-reactivity' },
1819
{ text: 'Videos', link: '/videos/getting-started' },
@@ -28,7 +29,6 @@ module.exports = {
2829
'/learn/': [{
2930
text: 'Learn',
3031
items: [
31-
{ text: 'Installation', link: '/learn/00-installation' },
3232
{ text: 'Build your first app', link: '/learn/01-build-your-first-app' },
3333
{ text: 'Build a dashboard', link: '/learn/02-build-a-dashboard' },
3434
{ text: 'Create a custom block', link: '/learn/03-create-a-block' }

install.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Install blockr
3+
description: Install the blockr meta-package and optional extras.
4+
---
5+
6+
# Install blockr
7+
8+
You need [R](https://www.r-project.org/) 4.1 or later. Most users access blockr through a hosted server (e.g. [blockr.cloud](https://blockr.cloud)) and don't need to install anything locally.
9+
10+
## blockr <Badge type="tip" text="recommended" />
11+
12+
blockr is on CRAN, but it's under heavy active development. Install from GitHub to get current bug fixes and features:
13+
14+
```r
15+
# install.packages("pak")
16+
pak::pak("BristolMyersSquibb/blockr")
17+
```
18+
19+
[blockr](https://bristolmyerssquibb.github.io/blockr/) is a meta-package. It pulls in the core engine and the main block libraries: [blockr.core](https://bristolmyerssquibb.github.io/blockr.core/), [blockr.dock](https://bristolmyerssquibb.github.io/blockr.dock/), [blockr.dag](https://bristolmyerssquibb.github.io/blockr.dag/), [blockr.dplyr](https://bristolmyerssquibb.github.io/blockr.dplyr/), [blockr.ggplot](https://bristolmyerssquibb.github.io/blockr.ggplot/), [blockr.io](https://bristolmyerssquibb.github.io/blockr.io/).
20+
21+
Launch a board:
22+
23+
```r
24+
blockr::run_app()
25+
```
26+
27+
If you'd rather use the released version:
28+
29+
```r
30+
install.packages("blockr")
31+
```
32+
33+
## Optional extras
34+
35+
These packages aren't bundled into the meta-package. Install whichever you need.
36+
37+
### Session management: [blockr.session](https://bristolmyerssquibb.github.io/blockr.session/)
38+
39+
Save, restore, and share board state across users.
40+
41+
```r
42+
pak::pak("BristolMyersSquibb/blockr.session")
43+
```
44+
45+
### Dashboard blocks: [blockr.bi](https://github.com/cynkra/blockr.bi)
46+
47+
Drilldown, crossfilter, tiles, and KPI cards. New, but you'll want these for complex dashboards.
48+
49+
```r
50+
pak::pak("cynkra/blockr.bi")
51+
```
52+
53+
## More
54+
55+
Other packages (AI assistant, code export, stats, vertical demos) live in the [package overview](/packages/). The list there is the source of truth and may shift as packages stabilise or get folded into the meta-package.

learn/00-installation.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

learn/01-build-your-first-app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This tutorial will get you started with blockr in just a few minutes.
44
By the end, you will have built your first data pipeline.
55

6-
Make sure blockr is running — see [Installation](00-installation) if you haven't set it up yet.
6+
Make sure blockr is running. See [Installation](/install) if you haven't set it up yet.
77

88
## Load data
99

0 commit comments

Comments
 (0)