Skip to content

Commit b4027d6

Browse files
committed
docs: cover v0.31 workflows in user guides
1 parent d1d14f0 commit b4027d6

10 files changed

Lines changed: 156 additions & 12 deletions

File tree

‎content/docs/operations/backup-restore.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Plan recoverable backups for the database and any external attachme
55

66
Your backup plan depends on both the database backend and the attachment storage backend.
77

8+
To download or move only your own memos, use **Settings → Export & Import** instead. The [Export & Import guide](/docs/usage/export-import) explains the ZIP format, conflict choices, and Space handling. A personal export does not include other users' memo content, accounts, settings, or Space memberships, so it does not replace the instance backups described here.
9+
810
## Default data directory layout
911

1012
```

‎content/docs/usage/attachments.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Attachments let you keep files close to the notes they belong to. This is useful
1111
- use the upload control in the toolbar
1212
- paste screenshots directly from the clipboard when supported
1313

14+
The app uploads files in smaller chunks automatically. No separate setting is needed; the instance's file-size limits still apply.
15+
1416
## Inline images and drafts
1517

1618
Images can be inserted at the cursor through upload, paste, drag and drop, or selection from existing attachments. They become Markdown images in the memo body. Other files remain attachments you can open from the memo.
@@ -48,7 +50,7 @@ The Attachments page lets you browse, preview, and manage your uploads. Its resu
4850

4951
- files are grouped into **Media**, **Audio**, and **Documents** tabs, each with a live count
5052
- media is shown as a grid grouped by month; images, videos, and motion photos open in a full-screen lightbox
51-
- audio files play inline, and documents are listed as rows you can open in a new tab
53+
- audio files play inline, with playback-speed choices including 0.5× and 0.75×; documents are listed as rows you can open in a new tab
5254
- every attachment links back to the memo it belongs to, or is flagged when it isn't linked to any memo
5355
- long lists load in pages with a **Load more** button
5456

@@ -64,12 +66,16 @@ Deleting unused attachments is permanent, so review the list before confirming.
6466

6567
## Storage implications
6668

69+
Open **Settings → My Account** and look under **Statistics → Attachment storage** to see your account's attachment storage usage. Review unused uploads in the attachment library when you want to reclaim space.
70+
6771
Attachments depend on the storage backend chosen for the instance:
6872

6973
- database storage keeps everything together
7074
- local filesystem storage keeps files on the host or volume
7175
- S3-compatible storage separates files from the app host
7276

77+
Admins can configure multiple named storage backends. Changing the backend for new uploads does not move existing files. A [personal memo export](/docs/usage/export-import) includes the managed files attached to your exported memos, regardless of their storage backend.
78+
7379
## Access to managed files
7480

7581
Managed files follow the memo's access rules. Memos serves S3-backed attachments through its authenticated file route, including range requests for media playback. A shared memo supplies authorized attachment URLs; preserve their share tokens when copying or rendering thumbnails.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Export & Import
3+
description: Download your memos and attachments as a ZIP file, then import them into your account on another Memos instance.
4+
---
5+
6+
Use **Settings → Export & Import** to keep a portable copy of your memos or move them to another instance. Export and import are available starting in Memos 0.31.
7+
8+
## Export your memos
9+
10+
1. Sign in to the account whose memos you want to export.
11+
2. Open **Settings → Export & Import**.
12+
3. Under **Export memos**, choose **Export memos** and wait for the ZIP download.
13+
14+
The file is named `memos-export-<username>-<timestamp>.zip`. It uses Memos Export Format, with Markdown content and JSON metadata for each memo, plus attached files. You can read the Markdown outside Memos; keep the original ZIP intact for importing.
15+
16+
The export includes all memos you authored across Spaces, regardless of the current sidebar filters:
17+
18+
- active and archived memos, including comments you wrote
19+
- creation and update times, visibility, pinned state, location, and Space references
20+
- memo Relations and comment-parent references
21+
- files attached to those memos, including files stored in the database, on disk, or in S3-compatible storage
22+
23+
External attachment links remain links; their remote files are not downloaded into the ZIP. Unused uploads and other people's memo content are not included, even when you can read them. An export of your memos is therefore not a complete export of a shared Space or its discussions.
24+
25+
The ZIP can contain private notes and files and is not encrypted. Store it somewhere appropriate for that content.
26+
27+
## Import a Memos export
28+
29+
1. Sign in to your account on the destination instance.
30+
2. Open **Settings → Export & Import** and select **Choose file** under **Import memos**.
31+
3. Select the Memos export ZIP. Memos uploads and validates it before showing a preview; this step does not create or replace memos.
32+
4. Review the memo and attachment counts, existing-memo count, and warnings.
33+
5. If matching memos already exist in your account, choose how to handle them.
34+
6. Choose **Import … memos**, then review the result.
35+
36+
Older files using the `memos-archive` format name are also accepted. A ZIP containing arbitrary Markdown files is not a Memos export.
37+
38+
### Choose how to handle existing memos
39+
40+
Memos identifies an existing memo by its ID, not by identical text or title.
41+
42+
| Option | Result for a matching memo in your account |
43+
| --- | --- |
44+
| **Keep mine** | Skip it and keep your current version. This is the default. |
45+
| **Replace with the imported version** | Replace it with the exported content and settings. Export before using this if you need to retain the current version. |
46+
| **Create a copy** | Leave it unchanged and create a separate memo with a new ID. Repeating this option creates more copies. |
47+
48+
Memos without a match are created in your signed-in account. An ID collision with another user's memo creates a new ID rather than replacing their memo.
49+
50+
### Spaces, visibility, and discussions
51+
52+
Import does not create Spaces or memberships. It tries to match each exported Space to one you actively belong to, first by ID and then by name. If you want to keep that placement, create or join the destination Spaces before importing.
53+
54+
If no Space matches, the memo becomes **Unassigned**. A `SPACE` memo without a matching Space becomes `PRIVATE`, and the import reports a warning. Other visibility values are preserved, so review the audience before importing into an instance with different users or public-access settings.
55+
56+
Relations and comment threads are restored when their target memos can be resolved. A missing parent causes a new comment to become a top-level memo; missing references are omitted, with warnings. Replacing an existing memo does not change its comment parent. Reactions are recorded in the export for reference but are not recreated by import.
57+
58+
### Review the result
59+
60+
The report lists **Created**, **Updated**, **Skipped**, and **Failed** counts, plus warnings and individual failures. Some memos can succeed while others fail, so inspect the report before deciding whether to retry. Destination content and attachment limits still apply.
61+
62+
If the uploaded file expires before you confirm the import, choose the file again. Keep the source account and ZIP until you have checked the imported content, attachments, placement, and visibility.
63+
64+
## Personal exports and instance backups
65+
66+
Use this feature for your own memo content. It does not transfer user accounts, account or instance settings, access tokens, share links, revision history, or Space membership. For recovery of an entire instance, back up its database, attachment storage, and configuration following [Backup & Restore](/docs/operations/backup-restore).
67+
68+
To share a picture of one memo instead, use [Share as image](/docs/usage/sharing#share-as-image).

‎content/docs/usage/inbox.mdx‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Inbox
3-
description: Track comments and mentions on your memos from a single notification center.
3+
description: Review comments, mentions, and Space invitations from a single notification center.
44
---
55

66
The inbox is your notification center for collaboration activity. It collects events that involve you so you don't have to revisit memos to find replies.
@@ -11,6 +11,7 @@ The inbox surfaces collaboration notifications:
1111

1212
- **Comments** — someone commented on one of your memos
1313
- **Mentions** — someone mentioned you with `@` in a memo or comment
14+
- **Space invitations** — someone invited you to join a Space on this instance
1415

1516
Rows show the sender, activity, and time, with memo context when available. The sidebar Inbox action carries an unread-count badge. Inbox remains global when you select a Space.
1617

@@ -22,7 +23,13 @@ Open the inbox to see notifications newest-first. The contextual sidebar filters
2223
- **Unread** — notifications you haven't opened yet
2324
- **Archived** — notifications you've cleared
2425

25-
Clicking a notification opens the related memo or comment and marks the notification read.
26+
Clicking a comment or mention notification opens the related memo or comment and marks the notification read.
27+
28+
## Respond to a Space invitation
29+
30+
An invitation shows the Space, sender, and proposed role. Choose **Accept** to join or **Decline** to dismiss the invitation. After accepting, choose **Open space** to browse it.
31+
32+
You do not gain membership until you accept. Archiving or deleting the notification does not accept the invitation; you can also manage pending invitations in **Settings → Spaces**. See [Spaces](/docs/usage/spaces) for member roles and visibility rules.
2633

2734
## Managing notifications
2835

‎content/docs/usage/index.mdx‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Capture a thought, find it again, and decide who can read or respond to it. Thes
99

1010
<Cards>
1111
<Card title="Memos" href="/docs/usage/memos" icon="FileText">
12-
Create and edit notes, link related memos, pin important content, and choose placement and visibility.
12+
Write and edit notes, browse by date or location, and choose placement and visibility.
1313
</Card>
1414
<Card title="Attachments" href="/docs/usage/attachments" icon="HardDrive">
1515
Add images and files to a memo, browse the attachment library, and review unused uploads.
@@ -46,23 +46,33 @@ Capture a thought, find it again, and decide who can read or respond to it. Thes
4646
Acknowledge notes, participate in discussions, and mention other users with the right access.
4747
</Card>
4848
<Card title="Inbox" href="/docs/usage/inbox" icon="MessageSquare">
49-
Review comment and mention notifications, open their context, and manage read status.
49+
Review comments and mentions, respond to Space invitations, and manage notifications.
5050
</Card>
5151
<Card title="Linked Identities" href="/docs/usage/linked-identities" icon="Link">
5252
Link an external SSO account so it signs in to your existing Memos user.
5353
</Card>
5454
</Cards>
5555

56+
## Keep or move your data
57+
58+
<Cards>
59+
<Card title="Export & Import" href="/docs/usage/export-import" icon="Download">
60+
Download your memos and attachments as a ZIP, then import them into another account or instance.
61+
</Card>
62+
</Cards>
63+
5664
## Choose the question you need to answer
5765

5866
| If you want to know… | Start with… |
5967
| --- | --- |
6068
| How do I write a note with a checklist or image? | [Memos](/docs/usage/memos), [Writing Markdown](/docs/usage/writing-markdown), and [Attachments](/docs/usage/attachments) |
6169
| How do I return to the same set of related notes? | [Tags](/docs/usage/tags) and [Views](/docs/usage/views) |
6270
| How do I find an older note or clear it from my timeline? | [Search & Archive](/docs/usage/search-archive) |
71+
| How do I revisit notes from a date or place? | [Browsing your memos](/docs/usage/memos#browsing-your-memos) |
6372
| How do I work with a group and control who can read a memo? | [Spaces](/docs/usage/spaces) and [Sharing](/docs/usage/sharing) |
6473
| How do I join a discussion and keep track of replies? | [Reactions & Comments](/docs/usage/reactions-comments) and [Inbox](/docs/usage/inbox) |
6574
| How do I connect SSO to the account I already use? | [Linked Identities](/docs/usage/linked-identities) |
75+
| How do I download my memos or move them to another instance? | [Export & Import](/docs/usage/export-import) |
6676

6777
Start with a few memos and add tags or Views when you have something you want to revisit. When collaborating, check placement and visibility separately: assigning a memo to a Space does not automatically make it visible to that Space's members.
6878

‎content/docs/usage/memos.mdx‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Memos are the central unit of content in the product. A good memo practice keeps
1616

1717
## Navigation and creation
1818

19-
The resizable sidebar contains the calendar, Views, tags, Quick Find, and navigation for the current route. Open the global composer from the sidebar to write without returning to Home.
19+
The resizable sidebar contains [Calendar](#calendar), [Map](#map), Views, tags, Quick Find, and navigation for the current route. Open the global composer from the sidebar to write without returning to Home.
2020

2121
Selecting a Space scopes browsing and memo creation to that Space. Check placement and visibility before saving; assigning a memo does not change its audience. Existing memos remain Unassigned after upgrading. See [Spaces](/docs/usage/spaces) for scope and membership rules.
2222

@@ -38,6 +38,10 @@ Authors can edit their own memos; editing an assigned memo also requires active
3838

3939
## Browsing your memos
4040

41+
Home, Calendar, and Map show your active memos within the selected [Space](/docs/usage/spaces), [View](/docs/usage/views), and tag filters. Select the main **Memos** context to browse your memos across Spaces. Selecting a Space does not make Calendar or Map show every member's notes. Archived memos are available separately under [Archived](/docs/usage/search-archive#archive).
42+
43+
### Feed
44+
4145
Choose one, two, three, or automatic columns in your display preferences.
4246
Compact mode and link previews are configurable there too, and the choices are
4347
saved for your account. Link previews discover metadata from oEmbed, Open Graph, Twitter Cards, JSON-LD, and ordinary HTML when the linked site supplies it. Sites without usable metadata may still appear as plain links. The single-column layout shows full memo content by
@@ -47,6 +51,30 @@ New memos appear above the pinned section. When you return from a memo detail
4751
page, Memos restores your previous feed position so you can continue where you
4852
left off.
4953

54+
### Calendar
55+
56+
Open **Calendar** from the sidebar to revisit a day's notes or review a month. Use the previous and next month controls, or select the month heading to choose another month and year. **Today** returns to the current month.
57+
58+
Select a day to read its memos in a panel on desktop or below the grid on mobile. Days show counts and previews when available. The calendar uses your local time zone and the selected creation or update time setting, with creation time as the default.
59+
60+
To fill in an entry for a particular date, open that day and choose **New memo on this day**. The composer starts with that date as the creation and update time and uses the current Space. Check the date, placement, and visibility before saving. Later edits can move a memo to a different day when browsing by update time; use creation time to review a journal by its entry dates.
61+
62+
Calendar groups notes by their timestamps; it does not assign due dates to checklist items. If a day looks empty, check the active filters and time setting.
63+
64+
### Map
65+
66+
Open **Map** from the sidebar to browse memos with saved locations. Select a marker to read the notes at that location, or choose **Show all results** to fit the matching locations into view. With a single location selected, **Write here** starts a memo with that location and the current Space filled in.
67+
68+
To add a location to a memo:
69+
70+
1. Create or edit the memo and choose **Add location** from the editor's add menu.
71+
2. Select a point on the map or enter latitude and longitude. Allowing browser location access can help set your current position; you can also choose manually.
72+
3. Enter a location label, choose **Confirm**, and save the memo.
73+
74+
Writing a place name or attaching a photo with location metadata does not by itself place the memo on Map. Anyone who can read the memo can see its saved location, so check visibility before sharing.
75+
76+
If no markers appear, check for saved locations and active filters; use **Clear filters** when offered. A newly saved memo may fall outside the current filters. If the map background fails to load, use **Retry**; your memo results remain available.
77+
5078
## Memo detail
5179

5280
Opening a memo shows its full content and discussion alongside a property rail
@@ -96,3 +124,4 @@ A Relation does not grant access to either memo. Each side keeps its own visibil
96124
- [Use Memos as a Digital Bullet Journal](/docs/guides/bullet-journal) for rapid logging and reflection.
97125
- [Use Memos for GTD](/docs/guides/getting-things-done) for action management.
98126
- [Build a Zettelkasten in Memos](/docs/guides/zettelkasten) for connected knowledge.
127+
- [Export & Import](/docs/usage/export-import) to download your memos and attachments or move them to another instance.

‎content/docs/usage/meta.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"reactions-comments",
1313
"inbox",
1414
"linked-identities",
15-
"search-archive"
15+
"search-archive",
16+
"export-import"
1617
]
1718
}

‎content/docs/usage/search-archive.mdx‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ Search works best when you keep memo titles, headings, and tags consistent.
2020

2121
Open Quick Find with the sidebar search action. The global Cmd/Ctrl+K shortcut was removed in 0.31.
2222

23+
- **Text** searches for words in memo content. Matching text is highlighted in the results.
24+
- **Expression** accepts the same [CEL filter syntax as Views](/docs/usage/views#filter-expression-syntax), for example `has_location && tag in ["travel"]` or `space == null && has_incomplete_tasks`.
25+
26+
Press **Enter** to search. In Expression mode, **Shift+Enter** adds a new line. Check the scope shown at the top of Quick Find: the current collection, Space, View, and filters can narrow the results. To reuse an expression, copy it into a new [View](/docs/usage/views#create-a-view).
27+
28+
Searching from Calendar, Map, or Attachments opens the matching memo list in Home within the same Space context.
29+
2330
Home and Explore filters follow the selected Space. [Views](/docs/usage/views) reuse CEL expressions, including `has_location`, `space == null` for Unassigned memos, and `visibility == "SPACE"` for members-only memos.
2431

2532
## Archive

0 commit comments

Comments
 (0)