Tools and sources
Where the example Package comes from, its version and the files in it.
A Deliverable is what you end up using. A Helper is a tool needed to make it or run it. The example has only one deliverable, and running it only needs the Lorevik desktop App.
This page follows the Lorevik Docs standard.
Tool list#
| Tool | Type | Source | Version | Install command |
|---|---|---|---|---|
| Learning Local Sample | Deliverable | To confirm | 0.2.0 | Click "Install free on this device" in Explore |
| Lorevik desktop App | Helper | Lorevik | Follows the version you installed | Download from the website |
Learning Local Sample#
A fixed, invented Package that ships with the Lorevik desktop App. "Install" in Explore only copies the App's own copy into your Vault. There is no download and no creator update.
| File | Role |
|---|---|
service.html | The Page, which renders courses and sessions |
data.json | Example data for two invented courses and seven sessions |
SKILL.md | Instructions for the Agent |
SURFACE.md | Data structure: course ids, session ids, table of contents anchors |
AGENTS.md, DESIGN.md | Rules for changing the data and the interface |
metadata.json | Name, version, and the size and sha256 of each file |
To confirm: The example's source is
public/demos/learning-shell/in the Lorevik repo. The repo is private, and there is no public address to put here yet.
Agentbefore changing the example data, read SURFACE.md, and check the course ids, session ids and table of contents anchors before making a new version.
Install In Lorevik's Explore, open "Learning Local Sample", click Install free on this device and confirm.
Configure No configuration needed.
Verify "Learning Local Sample" appears in the Sidebar on the left, and opening it shows two courses.
Version 0.2.0, from metadata.json.
Lorevik desktop App#
The example opens in the Lorevik desktop App. It can only be installed in the App; on the web it can only be previewed.
Agentyou do not install this; the user installs it.
Install Download the Mac version from the Lorevik website and drag it into Applications.
Configure The first time you open it, choose a folder as your Vault. The example is installed into its living-surfaces/.
Verify Explore is visible in the Sidebar on the left.
Version Follows the version you installed.