diff --git a/src/pages/beta/index.astro b/src/pages/beta/index.astro index 696254c..3e643eb 100644 --- a/src/pages/beta/index.astro +++ b/src/pages/beta/index.astro @@ -10,7 +10,8 @@ import BaseLayout from "../../layouts/BaseLayout.astro";

Create a Connect account

- A Connect account syncs and shares your collections. + A Connect account lets apps use your collections, and syncs and shares + them across your devices and with other people.

Sign up diff --git a/src/pages/connect/index.astro b/src/pages/connect/index.astro index 7c58314..4d43873 100644 --- a/src/pages/connect/index.astro +++ b/src/pages/connect/index.astro @@ -4,33 +4,78 @@ import BaseLayout from "../../layouts/BaseLayout.astro";

mdbase Connect

- Connect is the account that syncs and shares your collections. This page - explains what you choose for each collection, what mdbase can read, and - how apps, people and devices get access. + Connect lets apps use your Markdown collections as their database. An app + doesn’t keep your data in its own storage. It asks for access to one of + your collections, then finds, creates and edits records there, and + every change is saved as a Markdown file you own.

+
+

How it works

+

+ Say you keep your tasks in a collection. Each task is a Markdown file, + like tasks/renew-passport.md: +

+ 
---
+type: task
+title: Renew passport
+status: open
+due: 2026-12-01
+---
+
+Book a photo appointment first.
+

+ Connect TaskNotes to that collection and it queries + the records of type task to build its lists. Mark this one + done and TaskNotes changes status in the file. Edit the due + date in a text editor and TaskNotes shows the new date. Any other app you + connect to the same collection sees the same records, so nothing has to + be exported from one app to another. +

+

+ Connect is the account that makes this work. It handles sign-in, the + permissions you grant, syncing between your devices, and sharing with + other people. +

+
+ +
+

Apps ask first

+

+ When you connect an app, you sign in to Connect, choose one collection, + and see the operations the app asks for before you approve it. You might + let a project planner find, create and edit project records while leaving + deletion blocked. +

+

+ The permission is recorded with the collection, and every copy checks it: + your devices and, for Cloud copy, mdbase’s copy. You can narrow or revoke + a permission at any time. Removing an app never removes the collection, + and your other apps keep using it. +

+
+

Cloud copy or Private

- When you turn on sync for a collection, every device that syncs it keeps a - complete copy as ordinary files and works offline. Each change is locked - on the device before it leaves. mdbase passes it to your other devices - and can’t read it. You choose one of two options for each collection: + Connect keeps each collection in sync across your devices. Every device + that syncs it keeps a complete copy as ordinary files and keeps working + offline. For each collection, you choose whether mdbase can read it:

Cloud copy
- The default for new accounts. mdbase also keeps a readable copy of the - collection and holds its key. Web apps keep working while your devices - are off, and a new device joins when you sign in. + The default. mdbase keeps a readable copy of the collection, so web + apps keep working while your devices are off, and a new device joins + when you sign in.
@@ -52,47 +97,16 @@ import BaseLayout from "../../layouts/BaseLayout.astro";

Add a device

- For a Cloud copy collection, sign in on the new device. Once your account - approves it, the device receives the collection key and downloads its - copy. None of your other devices need to be online. -

-

- Cloud copy needs no encryption password. If you choose Private for a - collection, you set an encryption password when you create your first - Private collection, and mdbase shows you a recovery key once. Keep the - recovery key in a password manager or on paper. To add a device, sign in - and enter your encryption password or the recovery key. mdbase stores your - key only in a form locked with your password, so it can’t reset the - password for you. The recovery key is how you get back in if you forget it. + For a Cloud copy collection, sign in on the new device and it downloads + the collection. For a Private collection, you also unlock it with your + encryption password or recovery key, or, in strict mode, approve it from + a device you already have. See + Private collection keys for how + this works.

- If you’d prefer mdbase to store no copy of that key, turn on strict mode. - You then approve each new device from one you already have, by checking - that both screens show the same six-digit code. -

-

- If you lose a device, remove it from your account. The collection gets a - new key, so the removed device receives no further changes. It keeps the - files it already had. -

-
- -
-

Apps ask first

-

- An app asks for access to one collection and lists the operations it - needs, such as finding, creating and editing records. You choose the - collection and see what the app asks for before you approve it. -

-

- The permission is recorded with the collection, and every copy checks it: - your devices and, for Cloud copy, mdbase’s copy. In a Private collection, - a new permission takes effect once one of your signed-in devices has - recorded it. You aren’t asked again on the device. -

-

- You can narrow or revoke a permission at any time. Removing an app - never removes the collection, and your other apps keep using it. + If you lose a device, remove it from your account. It receives no further + changes but keeps the files it already had.

@@ -123,44 +137,6 @@ import BaseLayout from "../../layouts/BaseLayout.astro";

-
-

If you used Connect before

-

- Existing accounts move to the new sync system automatically, in waves. - You don’t need to export anything, and your files stay where they are. -

-
    -
  • - Collections hosted by Connect become Cloud copy - collections, with their records, files, record IDs and members. Folders - that mirrored them join the new collection once the desktop app is - updated. Edits that weren’t uploaded yet arrive then, or are held for - review if the record also changed elsewhere. -
    • -
  • - Local collections served by the Connector become - Private collections when the updated desktop app{" "} - takes them over on that computer. They keep their files, record IDs - and app permissions, and they’re end-to-end encrypted, so mdbase can’t - read them. Keep that computer online while it moves them. -
    • -
  • - Apps need their current versions. Older versions can’t - reach migrated collections and will ask you to update, and you may need - to approve some apps again. -
    • -
  • - Notes larger than 1 MiB move too. They stay as - Markdown files but aren’t in the normal record index, so they may not - appear in app lists or searches. -
    • -
-

- mdbase keeps the old system’s copy of each collection for 90 days after - it moves, for recovery. -

-
-

Get started

@@ -170,5 +146,10 @@ import BaseLayout from "../../layouts/BaseLayout.astro"; existing account. See the apps that work with mdbase collections.

+

+ Building an app? Connect a browser + app walks through sign-in, choosing a collection and working with + records using the SDK. +

diff --git a/src/pages/downloads/index.astro b/src/pages/downloads/index.astro index 6f93681..3893d18 100644 --- a/src/pages/downloads/index.astro +++ b/src/pages/downloads/index.astro @@ -116,24 +116,6 @@ const releaseSize = (bytes: number) => `${Math.round(bytes / 1_000_000)} MB`;

-
-

Updating from the Connector

-

- Install this release over your existing copy. When your account moves to - the new sync system, the app takes over the collections the Connector - served and turns them into Private collections. Their files, record IDs - and app permissions carry over. Folders that mirrored a collection stored - by Connect join its Cloud copy. -

-

- On a headless install, mdbase migrate status shows progress - for each collection, and mdbase migrate start runs or - resumes the takeover. See{" "} - if you used Connect before{" "} - for what changes. -

-
-

Release details

diff --git a/src/pages/index.astro b/src/pages/index.astro index 40969d0..176e4a1 100644 --- a/src/pages/index.astro +++ b/src/pages/index.astro @@ -83,7 +83,7 @@ easier to understand.

Get started

-

Sign up for mdbase Connect, the account that syncs and shares your collections. Your account starts with a small Cloud copy collection that you can open in any app. To sync a folder on your computer, as Cloud copy or Private, use the desktop app.

+

Sign up for mdbase Connect, the account that lets apps use your collections, and syncs and shares them. Your account starts with a small Cloud copy collection that you can open in any app. To sync a folder on your computer, as Cloud copy or Private, use the desktop app.

Sign upDownload the desktop appSee all apps

Building an app? Any app can work with an mdbase collection. Read the SDK documentation and the specification. The specification, Connect, Reader and Writer are open source under the MIT licence, on GitHub.