docs: finalize slugs & other minor fixes

KJ-GM · Jun 22, 2023 · ea02552 · ea02552
1 parent 4438d96
commit ea02552
Show file tree

Hide file tree

Showing 31 changed files with 98 additions and 109 deletions.
diff --git a/docs/help/contents/backup-and-restore-notes-in-notesnook.md b/docs/help/contents/backup-and-restore-notes-in-notesnook.md
@@ -1,15 +1,14 @@
 ---
 title: Backup and restore
-index: 5
 ---
 
-# How to Backup your notes
+# Backup your notes
 
 It is always a good practice to take a backup of your data so in case you lose access to your account, you don't lose your notes. Currently backups are local only.
 
 > warning
 >
-> Since all your data is end-to-end encrypted, we do not have the access to restore your account if you forgot your account password and recovery key. Therefore we recommend that you store your password safely and make sure that you have saved your [account recovery key](/how-to-save-account-recovery-key).
+> Since all your data is end-to-end encrypted, we do not have the access to restore your account if you forgot your account password and recovery key. Therefore we recommend that you store your password safely and make sure that you have saved your account recovery.
 
 # [Desktop/Web](#/tab/web)
 
@@ -26,8 +25,8 @@ It is always a good practice to take a backup of your data so in case you lose a
 
 > info
 >
-> On **android** when you take a backup first time, you will be asked to select a folder on your phone where you would like to store backup files. You can always change your backup files location from `Backups > Change backup location`.
-> 
+> On **Android** when you take a backup first time, you will be asked to select a folder on your phone where you would like to store backup files. You can always change your backup files location from `Backups > Change backup location`.
+>
 > Regardless of the folder you select, Notesnook will create a folder "Notesnook/backups" inside it and store backup files there.
 
 ---
@@ -70,7 +69,7 @@ To keep your backups secure & private, it is recommended that you enable encrypt
 >
 > Backups are encrypted with your account password.
 
-## How to restore a backup
+# Restore a backup
 
 To restore a backup, you must be logged in to your Notesnook account.
 

diff --git a/docs/help/contents/creating-note.md → ...lp/contents/create-a-note-in-notesnook.md b/docs/help/contents/creating-note.md → ...lp/contents/create-a-note-in-notesnook.md
@@ -1,9 +1,4 @@
----
-title: Creating a note
-index: 1
----
-
-# Creating a note
+# Creating your first note
 
 You are in a notes app, the first thing you want to do is make a note.
 

diff --git a/...ontents/desktop-integration/auto-start.md → ...tegration/auto-start-on-system-startup.md b/...ontents/desktop-integration/auto-start.md → ...tegration/auto-start-on-system-startup.md
@@ -1,4 +1,4 @@
-# Auto start
+# Auto start on system startup
 
 If your workflow requires Notesnook to be always opened, it's a good idea to enable auto start on system startup:
 

diff --git a/...op-integration/jumplists-and-dock-menu.md → ...top-integration/jumplist-and-dock-menu.md b/...op-integration/jumplists-and-dock-menu.md → ...top-integration/jumplist-and-dock-menu.md
diff --git a/docs/help/contents/spell-checker.md → ...ents/desktop-integration/spell-checker.md b/docs/help/contents/spell-checker.md → ...ents/desktop-integration/spell-checker.md
diff --git a/...ntents/desktop-integration/system-tray.md → ...s/desktop-integration/system-tray-menu.md b/...ntents/desktop-integration/system-tray.md → ...s/desktop-integration/system-tray-menu.md
@@ -1,6 +1,4 @@
-# System tray
-
-## The system tray menu
+# System tray menu
 
 Notesnook features a system tray menu to give quick access to some common functions such as:
 

diff --git a/docs/help/contents/export-notes-from-notesnook.md b/docs/help/contents/export-notes-from-notesnook.md
@@ -1,12 +1,9 @@
----
-title: Exporting notes
-index: 6
----
-
-# How do I export a note from Notesnook?
+# Exporting notes
 
 You can export your notes as PDF, HTML, Markdown and Plain text files on desktop and mobile apps.
 
+## Exporting a single note
+
 # [Desktop/Web](#/tab/web)
 
 1. Right click on a note

diff --git a/docs/help/contents/encryption.md → ...help/contents/how-is-my-data-encrypted.md b/docs/help/contents/encryption.md → ...help/contents/how-is-my-data-encrypted.md
@@ -1,9 +1,4 @@
----
-title: How is my data encrypted
-index: 2
----
-
-# How is my data encrypted
+# How is my data encrypted?
 
 > warn Note
 >
@@ -80,6 +75,6 @@ Encryption only takes place when you sync. Each item in the database is encrypte
 
 > info
 >
-> See the whole process in action [here.](https://notesnook.com/#whynotesnook)
+> See the whole process in action [here.](https://vericrypt.notesnook.com/)
 
 This object is then sent to the server for storage. The server performs no further operation on this data (because it can't).
diff --git a/docs/help/contents/importing-notes/README.md b/docs/help/contents/importing-notes/README.md
@@ -1,6 +1,5 @@
 ---
-title: Notesnook importer
-index: 4
+title: Importing notes
 ---
 
 # Import notes from any notes app

diff --git a/docs/help/contents/importing-notes/index.yml b/docs/help/contents/importing-notes/index.yml
diff --git a/docs/help/contents/installation.md b/docs/help/contents/installation.md
@@ -1,6 +1,5 @@
 ---
 title: Installation
-index: 0
 ---
 
 # Installation
@@ -94,7 +93,7 @@ Notesnook can be downloaded on any linux distro via Snapcraft.
 
 # [Google Playstore](#/tab/android)
 
-If you have Google play services installed on your android phone, you can get Notesnook from Google Play store
+If you have Google play services installed on your Android phone, you can get Notesnook from Google Play store
 
 [Download from playstore](https://play.google.com/store/apps/details?id=com.streetwriters.notesnook)
 

diff --git a/docs/help/contents/lock-notes-with-private-vault.md b/docs/help/contents/lock-notes-with-private-vault.md
@@ -1,13 +1,8 @@
----
-title: Locking notes
-index: 7
----
-
-# How do I lock notes with private vault?
+# Locking notes
 
 Notesnook is a private notes app. All your notes are encrypted and secure by default. We can not read them even if we want to on our servers. However you can still add an extra layer of security and encrypt your most important and sensitive notes by adding them to a vault.
 
-Adding notes to private vault is useful when you do not want anyone to read your notes, even if they have access to your phone.
+Adding notes to private vault is useful when you do not want anyone to read your notes, _even if they have access to your phone_.
 
 ## Creating a vault
 
@@ -30,7 +25,7 @@ Adding notes to private vault is useful when you do not want anyone to read your
 
 ---
 
-## Locking a note
+## Lock a note
 
 # [Desktop/Web](#/tab/web)
 
@@ -48,11 +43,11 @@ Adding notes to private vault is useful when you do not want anyone to read your
 
 ---
 
-## Open/Edit/Delete a locked note
+## Open/edit/delete a locked note
 
 To open, edit or delete a locked note, you must provide the password for the vault to unlock it.
 
-## Unlocking note permanently
+## Unlock a note permanently
 
 # [Desktop/Web](#/tab/web)
 
@@ -70,7 +65,7 @@ To open, edit or delete a locked note, you must provide the password for the vau
 
 ---
 
-## Changing vault password
+## Change vault password
 
 # [Desktop/Web](#/tab/web)
 

diff --git a/...ntents/mobile-integration/home-widgets.md → ...mobile-integration/home-screen-widgets.md b/...ntents/mobile-integration/home-widgets.md → ...mobile-integration/home-screen-widgets.md
@@ -1,6 +1,6 @@
 # Home screen widgets
 
-Basic home screen widgets are availble on both android & ios for quick note taking.
+Basic home screen widgets are availble on both Android & iOS for quick note taking.
 
 # [iOS](#/tab/ios)
 

diff --git a/...obile-integration/pin-to-notifications.md → ...integration/pin-notes-to-notifications.md b/...obile-integration/pin-to-notifications.md → ...integration/pin-notes-to-notifications.md
diff --git a/...le-integration/quick-note-notification.md → ...tegration/quick-note-from-notification.md b/...le-integration/quick-note-notification.md → ...tegration/quick-note-from-notification.md
diff --git a/...ts/mobile-integration/share-extensions.md → ...tegration/share-things-from-other-apps.md b/...ts/mobile-integration/share-extensions.md → ...tegration/share-things-from-other-apps.md
@@ -1,6 +1,6 @@
-# Share extensions
+# Share things from other apps
 
-Basic web clipping support is available on both android & ios apps via share extensions.
+Basic web clipping support is available on both Android & iOS apps via share extensions.
 
 We are going to use browser app as an example to demonstarte how you can clip information from webpages and other apps on your iPhone.
 

diff --git a/docs/help/contents/note-version-history.md b/docs/help/contents/note-version-history.md
@@ -0,0 +1,15 @@
+# Note version history
+
+Notesnook keeps a constant log of all your edit sessions. These are stored as "versions" of a particular notes which you can view & restore to in case of data loss.
+
+## How it works
+
+Every time you create a new note or open an existing note, Notesnook creates a "session" for it. All the changes made to the note are also stored in that session in addition to the note itself.
+
+In short, if you open a note and edit it at 10 different times during the day, you'll have 10 previous versions of that note.
+
+## FAQs
+
+### Is note history synced to all my devices?
+
+No, at the moment we have decided to keep note version history local only. If you logout from your account, previous versions of all your notes will be cleared.
diff --git a/docs/help/contents/organization/README.md b/docs/help/contents/organization/README.md
@@ -1,15 +1 @@
----
-title: Organization
-index: 3
----
-
-# Organization
-
-Notesnook provides multiple ways to organize your notes.
-
-1. [Notebooks and topics](/organization/how-to-organize-notes-with-notebooks)
-2. [Tags](/organization/how-do-i-add-tags-to-notes)
-3. [Colors](/organization/how-do-i-organize-notes-using-colors)
-4. [Favorites](/organization/how-do-i-organize-notes-using-favorites)
-5. [Pins](/organization/how-do-i-pin-notes-and-notebooks)
-6. [Shortcuts](/organization/how-do-i-add-shortcuts-to-side-menu)
+# Organizing notes
diff --git a/...n/how-do-i-organize-notes-using-colors.md → ...ganization/organize-notes-using-colors.md b/...n/how-do-i-organize-notes-using-colors.md → ...ganization/organize-notes-using-colors.md
@@ -1,6 +1,5 @@
 ---
 title: Colors
-index: 3
 ---
 
 # Organize notes with colors

diff --git a/...ow-do-i-organize-notes-using-favorites.md → ...ization/organize-notes-using-favorites.md b/...ow-do-i-organize-notes-using-favorites.md → ...ization/organize-notes-using-favorites.md
@@ -1,6 +1,5 @@
 ---
 title: Favorites
-index: 4
 ---
 
 # Add notes to favorites

diff --git a/...n/how-to-organize-notes-with-notebooks.md → ...ization/organize-notes-using-notebooks.md b/...n/how-to-organize-notes-with-notebooks.md → ...ization/organize-notes-using-notebooks.md
@@ -1,6 +1,5 @@
 ---
 title: Notebooks
-index: 0
 ---
 
 # Organizing notes with notebooks
@@ -21,7 +20,6 @@ Notebooks consist of topics where you can add/create and edit your notes.
 >
 > Adding a description & topics are optional.
 
-
 # [Mobile](#/tab/mobile)
 
 1. Go to `Notebooks` from side menu.

diff --git a/...rganization/how-do-i-add-tags-to-notes.md → ...organization/organize-notes-using-tags.md b/...rganization/how-do-i-add-tags-to-notes.md → ...organization/organize-notes-using-tags.md
@@ -1,6 +1,5 @@
 ---
 title: Tags
-index: 1
 ---
 
 # Tags

diff --git a/...ation/how-do-i-pin-notes-and-notebooks.md → ...s/organization/pin-notes-and-notebooks.md b/...ation/how-do-i-pin-notes-and-notebooks.md → ...s/organization/pin-notes-and-notebooks.md
@@ -1,6 +1,5 @@
 ---
 title: Pins
-index: 5
 ---
 
 # Pin notes and notebooks

diff --git a/...on/how-do-i-add-shortcuts-to-side-menu.md → ...tents/organization/side-menu-shortcuts.md b/...on/how-do-i-add-shortcuts-to-side-menu.md → ...tents/organization/side-menu-shortcuts.md
@@ -1,9 +1,4 @@
----
-title: Shortcuts
-index: 6
----
-
-# Add shortcuts to side menu
+# Side menu shortcuts
 
 Unlike most note taking apps, you might have noticed that when you add a tag, create a notebook or a topic, they are not added automatically to the side menu for quick access. We have seen people with 100's of tags, all on the side menu.
 

diff --git a/docs/help/contents/privacy-mode.md b/docs/help/contents/privacy-mode.md
@@ -1,6 +1,6 @@
 # Privacy mode
 
-> error For Linux users
+> error Not available on Linux
 >
 > Privacy mode is not available on Linux.
 

diff --git a/.../contents/note-sharing-with-monographs.md → ...contents/publish-notes-with-monographs.md b/.../contents/note-sharing-with-monographs.md → ...contents/publish-notes-with-monographs.md
@@ -1,15 +1,12 @@
 ---
 title: Monographs
-index: 8
 ---
 
-# Monographs
+# Publish notes with monographs
 
-Sharing a note with someone can be such a tedious task. You have to copy/download/export it to a file and upload it to some cloud storage and then attach it in an email and send it to them.
+Sharing a note with someone can be such a tedious task. You have to copy/download/export it to a file and then attach it in an email or upload it to some cloud storage.
 
-With Notesnook, you don't need to do that anymore. Monographs enable you to share your notes with anyone in just one click. Once a note is published as a monograph, you get a public url which you can send to the person who needs access to information in the note.
-
-You can share this url with anyone to view the contents of the note without downloading Notesnook. And the cool part is, you can encrypt(lock) monographs with a password.
+With Notesnook, you don't need to do that anymore. Monographs enable you to share your notes with anyone in a single click. Once a note is published as a monograph, you get a public url which you can share with anyone. They don't need to download Notesnook or install any extra software — it's just like a blog, only simpler.
 
 ## How to publish a note?
 

diff --git a/docs/help/contents/versionhistory.md b/docs/help/contents/versionhistory.md
diff --git a/docs/help/contents/web-clipper/clipping-your-first-web-page.md b/docs/help/contents/web-clipper/clipping-your-first-web-page.md
@@ -1,7 +1,3 @@
----
-index: 1
----
-
 # Clipping your first web page
 
 ## Connecting with the web app

diff --git a/docs/help/contents/web-clipper/installation.md b/docs/help/contents/web-clipper/installation.md
@@ -1,6 +1,5 @@
 ---
 title: Installation
-index: 0
 ---
 
 # Installation

diff --git a/docs/help/contents/web-clipper/troubleshooting.md b/docs/help/contents/web-clipper/troubleshooting.md
@@ -1,7 +1,3 @@
----
-index: 2
----
-
 # Troubleshooting
 
 ## What to do if the web clipper doesn't connect?