Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lincolnthalles committed May 19, 2024
1 parent 2b4b44b commit 48e1755
Show file tree
Hide file tree
Showing 7 changed files with 69 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Memospot documentation

Documentation within "[Writerside](/Writerside/topics)" directory is handled by [JetBrains Writerside](https://www.jetbrains.com/writerside/).
Documentation within [Writerside](/Writerside/topics) directory is handled by [JetBrains Writerside](https://www.jetbrains.com/writerside/).

A custom Markdown syntax is used. These files are not meant to be read in GitHub.
7 changes: 7 additions & 0 deletions Writerside/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,11 @@
<noindex-content>false</noindex-content>
</variables>
</build-profile>
<footer>
<link href="https://github.com/memospot/memospot">GitHub</link>
<link href="https://github.com/memospot/memospot/releases">Download</link>
<link href="https://github.com/memospot/memospot/issues">Issues</link>
<link href="https://github.com/memospot/memospot/discussions">Discussions</link>
<link href="https://www.usememos.com/docs">Memos Documentation</link>
</footer>
</buildprofiles>
Binary file removed Writerside/images/doclogo.png
Binary file not shown.
30 changes: 29 additions & 1 deletion Writerside/topics/Data-migration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# Data migration

> The current version of Memos stores assets in a portable format.
>
> Data can be seamlessly moved between Memos containers and Memospot instances,
> regardless of the operating system.
> {style=note}
> Assets, resources and objects refer to the same thing.
## Data storage location

- Windows: `%LocalAppData%\memospot`
- POSIX systems: `~/.memospot` (a hidden folder in the user home)
- Inside Memos container: `/var/opt/memos`
- Memos' container host:
- `~/.memos`
- `/root/.memos`
- Near your `docker-compose.yml` file if you're using it.

> Relevant files:
> - `memos_prod.db`
> - `memos_prod.db-shm` (may not exist)
> - `memos_prod.db-wal` (may not exist)
> - `assets` directory
The `.thumbnail_cache` directory and its contents are generated as needed.

## Migrating data from earlier Memos versions

> None of this is needed if you have never stored assets outside the database or
> if you have used Memospot v0.1.3/v0.1.4 in the past since it contains a
> built-in database migrator.
Expand All @@ -20,7 +48,7 @@
> If you are coming from an old Memos version or skipped v0.18.2 and v0.19.0,
> consider installing
> [Memospot v0.1.4](https://github.com/memospot/memospot/releases/tag/v0.1.4).
> It will fix the database automatically on the first start. {style=note}
> It will fix all asset paths in the database automatically on the first start. {style=note}
## Legacy instructions {collapsible="true" default-state="collapsed"}

Expand Down
37 changes: 21 additions & 16 deletions Writerside/topics/Overview.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# Overview

[Memospot](https://github.com/memospot/memospot) is a self-contained
desktop version of [Memos](https://github.com/usememos/memos), a beautiful,
privacy-first, lightweight note-taking service.
[Memospot](https://github.com/memospot/memospot) is a self-contained desktop version of
[Memos](https://github.com/usememos/memos)—a privacy-first, lightweight note-taking service. Available for Windows, macOS, and Linux.

Available for Windows, macOS, and Linux.
This project allows you to use Memos locally without the Docker overhead or to easily test Memos before deploying a container. Data can be seamlessly moved between instances.

[![Download](https://img.shields.io/github/downloads/memospot/memospot/total?logo=github)](https://github.com/memospot/memospot/releases)
[![GitHub Stars](https://img.shields.io/github/stars/memospot/memospot?logo=github)](https://github.com/memospot/memospot)

## Main screen {collapsible="true" default-state="expanded"}

![demo](capture.webp){height=1499}
> Switch the page theme by clicking on the icon in the upper right to
> see Memospot in a different color scheme.
## Project goals
## Key features

- Provide an easy-to-use single user Memos instance
- Easy-to-use
- Full-featured [Memos experience](https://www.usememos.com/docs)
- Minimal overhead
- Data portability
- Enhanced privacy and data safety
- Enhanced privacy

## Requirements

Expand All @@ -40,16 +42,20 @@ Download the latest release for your platform from the
[allow the app to run](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unidentified-developer-mh40616/mac)
first.

## Data Portability {collapsible="true" default-state="expanded"}
## Data Portability

The current version of Memos stores assets in a portable format. You can freely
copy the database and assets folder from one system to another, from a hosted
Memos instance to a single-user Memospot installation, and the other way around.
> The current version of Memos stores assets in a portable format.
>
> Data can be seamlessly moved between Memos containers and Memospot instances,
> regardless of the operating system.
> {style=note}
> If you ever need to do a migration from an older Memos version, check
> [Data Migration](Data-migration.md).
> If your data is coming from Memos v0.18.1 or earlier, see
> [Data migration](Data-migration.md#migrating-data-from-earlier-memos-versions).
## Special Thanks {collapsible="true" default-state="expanded"}
## Special Thanks

This project is made possible by the following open-source projects:

[![Powered by Memos](powered_by_memos.webp "Memos"){height=128}](https://www.usememos.com/)

Expand All @@ -68,8 +74,7 @@ Memos instance to a single-user Memospot installation, and the other way around.

## Supporting

If you like this project, remember to
[⭐star](https://github.com/memospot/memospot) it.
If you appreciate this project, be sure to [⭐star](https://github.com/memospot/memospot) it on GitHub.

[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/lincolnthalles)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/N4N5VO0T7)
4 changes: 2 additions & 2 deletions Writerside/topics/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Post-updates

If you see an error while Memos' interface is loading, press F5 or right-click
the window and click reload.
If you see an error while Memos' interface is loading, or it stays white/gray,
press F5 or right-click the window and click reload.

This is caused by a stale WebView cache and also affects Memos' Docker
instances. It should happen only once right after the update.
Expand Down
15 changes: 9 additions & 6 deletions Writerside/topics/Updating-Memos.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ bundled with the latest tested Memos server version.

> An auto-updater is planned, but it's not yet available.
> The semantic version scheme used by Memos is `Major.Minor.Patch`. {style=note}
## Memos server standalone update

> While a standalone server update works in most cases, manual updates are
> strongly discouraged for anything other than a **Patch** version release.
While a standalone server update works in most cases, manual updates are
strongly discouraged for anything other than a **Patch** version release.

> The semantic version scheme used by Memos is `Major.Minor.Patch`. {style=note}
> Standalone updates can break things due to database and API changes
> that occur between Major and Minor versions. The current version of Memospot
Expand All @@ -38,9 +38,12 @@ Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.We
> [here.](https://raw.githubusercontent.com/memospot/memospot/main/memos-server-updater.ps1)
> {style=note}
> You must run PowerShell as Admin if you are using Memospot `MSI` installers.
> You must run PowerShell as Admin if you are using Memospot `MSI` installers,
> as they do a system-wide installation.
>
> This is **not** needed using the `NSIS`/`exe` installer. {style=warning}
> This is **not** necessary when using the NSIS/exe installer,
> as it only installs the application for the current user.
> {style=warning}
### Manual procedure {collapsible="true" default-state="collapsed"}

Expand Down

0 comments on commit 48e1755

Please sign in to comment.