Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 120 additions & 23 deletions docs/docs/Getting Started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,143 @@
sidebar_position: 1
---

# Tutorial Intro
# Getting Started with W3DS

Let's discover **Docusaurus in less than 5 minutes**.
Welcome to **W3DS (Web 3 Data Spaces)** - a decentralized data synchronization protocol that puts users in control of their data.

## Getting Started
## What is W3DS?

Get started by **creating a new site**.
W3DS is a protocol that enables seamless data synchronization across multiple platforms while ensuring users own and control their data. Instead of platforms storing user data in silos, W3DS allows users to store their data in their own **eVaults** and have platforms sync from these vaults.

Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
## Core Concept

### What you'll need
The fundamental principle of W3DS is simple: **Users, groups, and objects own their own eVaults**. All data about a person, group, or object is stored in their eVault, and platforms become frontends that display and interact with this data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not just frontends, but also acting as cache and aggregators


- [Node.js](https://nodejs.org/en/download/) version 20.0 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
### Key Principles
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we want to emphasisze that 2+3 == interoperability
and 1 and 4 is quite similar and related


## Generate a new site
1. **Data Ownership**: Users own their data, not platforms
2. **Platform Independence**: Platforms are interchangeable frontends
3. **Automatic Synchronization**: Data created on one platform automatically appears on all platforms
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add recommendation on message delivery queue implementation to account for evault/platform downtime

4. **Decentralized Storage**: Each user has their own eVault for data storage

Generate a new Docusaurus site using the **classic template**.
## How It Works: A Simple Example

The classic template will automatically be added to your project after you run the command:
Imagine User A creates a post on **Blabsy** (a social media platform):

```bash
npm init docusaurus@latest my-website classic
1. User A posts "Hello, world!" on Blabsy
2. Blabsy's Web3 Adapter syncs the post to User A's eVault
3. User A's eVault stores the post and notifies all registered platforms
4. **Pictique** (another social media platform) receives the notification
5. Pictique creates the post locally - User A now has a post on Pictique **without ever visiting Pictique**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this formulation will sound spooky to a lot of people out there


This is the power of W3DS: your data follows you across all platforms automatically.

## Architecture Overview

```mermaid
graph TB
subgraph Users["Users & Groups"]
UserA[User A<br/>eName: @user-a.w3id]
UserB[User B<br/>eName: @user-b.w3id]
Group1[Group 1<br/>eName: @group-1.w3id]
end
subgraph EVaults["eVaults"]
EVaultA[User A's eVault]
EVaultB[User B's eVault]
EVaultG1[Group 1's eVault]
end
Comment on lines +46 to +50
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename parent block to evault provider maybe?

subgraph Platforms["Platforms"]
Blabsy[Blabsy]
Pictique[Pictique]
OtherPlatform[Other Platforms]
end
subgraph Infrastructure["Infrastructure"]
Registry[Registry Service<br/>W3ID Resolution]
EVaultCore[eVault Core<br/>GraphQL API]
end
UserA -->|Owns| EVaultA
UserB -->|Owns| EVaultB
Group1 -->|Owns| EVaultG1
Blabsy -->|Read/Write| EVaultA
Pictique -->|Read/Write| EVaultA
OtherPlatform -->|Read/Write| EVaultA
EVaultA -->|Webhooks| Blabsy
EVaultA -->|Webhooks| Pictique
EVaultA -->|Webhooks| OtherPlatform
Blabsy -->|Resolve eName| Registry
Pictique -->|Resolve eName| Registry
Comment on lines +75 to +76
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we are not implying that other platforms will not be able to use registry service, maybe consider showing a dashed line reference

EVaultCore -->|Store Data| EVaultA
style UserA fill:#e1f5ff,color:#000000
style EVaultA fill:#fff4e1,color:#000000
style Blabsy fill:#e8f5e9,color:#000000
style Pictique fill:#e8f5e9,color:#000000
style Registry fill:#f3e5f5,color:#000000
style EVaultCore fill:#f3e5f5,color:#000000
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
## Key Components

### eVault Core

The command also installs all necessary dependencies you need to run Docusaurus.
The **eVault Core** is the central storage system that manages user data. It provides:

## Start your site
- **GraphQL API** for storing and retrieving data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

again, it feels that the first and the last should be united

- **Webhook delivery** to notify platforms of data changes
- **Access control** via ACLs (Access Control Lists)
- **MetaEnvelope storage** for structured data

Run the development server:
### Web3 Adapter

```bash
cd my-website
npm run start
The **Web3 Adapter** is a library that platforms use to:

- Sync local database changes to eVaults
- Convert between platform-specific schemas and global ontology schemas
- Handle bidirectional data synchronization
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if it is bidirectional why did we bother to say sync local db to vault above?


### Registry Service

The **Registry Service** provides:

- **W3ID resolution**: Maps eNames (like `@user-a.w3id`) to eVault URLs
- **Key binding certificates**: Stores public keys for signature verification
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whose signature?

- **Platform registration**: Tracks active platforms for webhook delivery

### Platforms

**Platforms** are applications that:

- Display and interact with user data
- Sync data to/from user eVaults
- Convert between local and global data schemas
- Handle webhooks to receive data updates

## Data Flow

When a user creates data on a platform:

```
User Action → Platform Database → Web3 Adapter → User's eVault → Webhooks → All Platforms
```

The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
1. **User Action**: User creates a post, message, or other data
2. **Platform Database**: Platform stores data locally
3. **Web3 Adapter**: Adapter converts data to global schema and syncs to eVault
4. **User's eVault**: eVault stores the data as a MetaEnvelope
5. **Webhooks**: eVault sends webhooks to all registered platforms (except the originating one)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we say somwhere that this is a very simple prototype-level implementation of the "awareness mechanism"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also might be worth having a sequence diagram of interactions between the layers inclusive of web 3 adapter internal implementation

registration sequence diagram might also help to understand the role of the provisioner and registry better for theoretical knowledge required to setup a w3ds environment locally

6. **All Platforms**: Other platforms receive webhooks and create the data locally

The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
## Next Steps

Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
- Learn more about [W3DS Basics](/docs/W3DS%20Basics/getting-started) - Deep dive into eVault ownership and data flow
- Understand [Authentication](/docs/W3DS%20Protocol/Authentication) - How users authenticate with platforms
- Learn about [Signing](/docs/W3DS%20Protocol/Signing) - Signature creation and verification
- Explore [Signature Formats](/docs/W3DS%20Protocol/Signature-Formats) - Technical details on cryptographic signatures
- Build a platform with the [Post Platform Guide](/docs/Post%20Platform%20Guide/getting-started) - Step-by-step guide to creating a W3DS-compatible platform
Loading