From 0bc86d7c7520726b9cdf49de831d43f3eccfefa0 Mon Sep 17 00:00:00 2001 From: Elian Doran Date: Wed, 29 Oct 2025 22:00:31 +0200 Subject: [PATCH] docs(guide): deduplicate home page with quick start --- .../UI Elements/Zoom.html | 4 +- .../en/User Guide/User Guide/FAQ.html | 46 ++++---- .../Third-party cloud hosting.html | 10 +- .../en/User Guide/User Guide/Quick Start.html | 28 +++-- docs/User Guide/!!!meta.json | 111 +++++++----------- docs/User Guide/User Guide.md | 34 +----- docs/User Guide/User Guide/Quick Start.md | 16 +-- 7 files changed, 97 insertions(+), 152 deletions(-) diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Zoom.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Zoom.html index 91e0383e7..b056e6fda 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Zoom.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Basic Concepts and Features/UI Elements/Zoom.html @@ -1,8 +1,8 @@

Zoom applies to the entire UI, including text.

-

On the desktop application, use the Global menu to +

On the desktop application, use the Global menu to zoom in/out.

On both web browser and the desktop, the keyboard shortcuts Ctrl+Shift++ and Ctrl+Shift+- can be used.

Adjusting the text size instead

As an alternative to the zoom, the text size can be individually adjusted - by going to Options → Appearance.

\ No newline at end of file + by going to Options → Appearance.

\ No newline at end of file diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/FAQ.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/FAQ.html index a394b3885..ad3ee3976 100644 --- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/FAQ.html +++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/FAQ.html @@ -25,14 +25,14 @@

Common request is to allow multiple users collaborate, share notes etc. So far I'm resisting this because of these reasons:

Server with web only access - Installs the application on the server and allows access from any web browser on any device, including mobile.

    -
  1. Server installation -
    2. -
  2. Mobile frontend (optional)
    3. -
  3. PikaPods managed hosting +
  4. Server Installation
    5. +
  5. Mobile Frontend (optional)
    6. +
  6. Third-party cloud hosting +

Combination of server and desktop/laptop - Install the application on both a server, for web access and data synchronisation, @@ -22,11 +23,12 @@ desktop application will sync and store the data locally so that it can be used when offline.

    -
  1. Server installation -
    2. -
  2. Mobile frontend (optional)
    3. -
  3. Desktop installation -
    4. -
  4. Synchronization +
  5. Server Installation
    6. +
  6. Mobile Frontend (optional)
    7. +
  7. Desktop Installation +
    8. +
  8. Synchronization +
\ No newline at end of file diff --git a/docs/User Guide/!!!meta.json b/docs/User Guide/!!!meta.json index e6b64a3a4..c7a50da3a 100644 --- a/docs/User Guide/!!!meta.json +++ b/docs/User Guide/!!!meta.json @@ -15,52 +15,17 @@ "type": "text", "mime": "text/html", "attributes": [ - { - "type": "relation", - "name": "internalLink", - "value": "poXkQfguuA0U", - "isInheritable": false, - "position": 10 - }, - { - "type": "relation", - "name": "internalLink", - "value": "WOcw2SLH6tbX", - "isInheritable": false, - "position": 20 - }, - { - "type": "relation", - "name": "internalLink", - "value": "RDslemsQ6gCp", - "isInheritable": false, - "position": 30 - }, - { - "type": "relation", - "name": "internalLink", - "value": "cbkrhQjrkKrh", - "isInheritable": false, - "position": 40 - }, { "type": "relation", "name": "internalLink", "value": "BFs8mudNFgCS", "isInheritable": false, - "position": 50 - }, - { - "type": "relation", - "name": "internalLink", - "value": "GTwFsgaA0lCt", - "isInheritable": false, "position": 60 }, { "type": "relation", "name": "internalLink", - "value": "yeEaYqosGLSh", + "value": "GTwFsgaA0lCt", "isInheritable": false, "position": 70 }, @@ -77,6 +42,13 @@ "value": "promoted,alias=Slug,single,text", "isInheritable": true, "position": 20 + }, + { + "type": "relation", + "name": "internalLink", + "value": "s3YCWHBfmYuM", + "isInheritable": false, + "position": 80 } ], "format": "markdown", @@ -1136,16 +1108,16 @@ { "type": "relation", "name": "internalLink", - "value": "cbkrhQjrkKrh", + "value": "poXkQfguuA0U", "isInheritable": false, - "position": 10 + "position": 20 }, { "type": "relation", "name": "internalLink", - "value": "poXkQfguuA0U", + "value": "cbkrhQjrkKrh", "isInheritable": false, - "position": 10 + "position": 30 }, { "type": "label", @@ -3063,6 +3035,20 @@ "type": "text", "mime": "text/html", "attributes": [ + { + "type": "relation", + "name": "internalLink", + "value": "x3i7MxGccDuM", + "isInheritable": false, + "position": 10 + }, + { + "type": "relation", + "name": "internalLink", + "value": "4TIF1oA4VQRO", + "isInheritable": false, + "position": 20 + }, { "type": "label", "name": "iconClass", @@ -3076,20 +3062,6 @@ "value": "zoom", "isInheritable": false, "position": 20 - }, - { - "type": "relation", - "name": "internalLink", - "value": "x3i7MxGccDuM", - "isInheritable": false, - "position": 30 - }, - { - "type": "relation", - "name": "internalLink", - "value": "4TIF1oA4VQRO", - "isInheritable": false, - "position": 40 } ], "format": "markdown", @@ -3111,15 +3083,7 @@ "isExpanded": false, "type": "text", "mime": "text/html", - "attributes": [ - { - "type": "label", - "name": "shareAlias", - "value": "quick-edit", - "isInheritable": false, - "position": 20 - } - ], + "attributes": [], "format": "markdown", "dataFileName": "Quick edit.md", "attachments": [ @@ -5349,13 +5313,6 @@ "isInheritable": false, "position": 30 }, - { - "type": "relation", - "name": "internalLink", - "value": "cbkrhQjrkKrh", - "isInheritable": false, - "position": 40 - }, { "type": "label", "name": "shareAlias", @@ -5369,6 +5326,20 @@ "value": "bx bx-run", "isInheritable": false, "position": 40 + }, + { + "type": "relation", + "name": "internalLink", + "value": "yeEaYqosGLSh", + "isInheritable": false, + "position": 50 + }, + { + "type": "relation", + "name": "internalLink", + "value": "cbkrhQjrkKrh", + "isInheritable": false, + "position": 60 } ], "format": "markdown", diff --git a/docs/User Guide/User Guide.md b/docs/User Guide/User Guide.md index 730a1cff5..2c982cb38 100644 --- a/docs/User Guide/User Guide.md +++ b/docs/User Guide/User Guide.md @@ -6,34 +6,8 @@ For a quick overview of the application, visit our website at [triliumnotes.org] > [!TIP] > The same documentation can be accessed locally from within the Trilium Notes application by pressing F1. -## Documentation +## Getting started -This [wiki](https://github.com/zadam/trilium/wiki) contains additional and more in-depth information on some topics. See the sidebar for listing of all available pages. - -## Quick Start - -### Choose the setup - -**Local only desktop/laptop** - Allows a single instance on a desktop and will save the notes locally on that desktop. - -* Desktop Installation - -**Server with web only access** - Installs the application on the server and allows access from any web browser on any device, including mobile. - -1. Server Installation -2. Mobile Frontend (optional) -3. Third-party cloud hosting - -**Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronization, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline. - -1. [missing note] - - Server Installation -2. Mobile Frontend (optional) -3. Desktop Installation -4. Synchronization[missing note] - -### Basic concepts - -1. Understand Notes.[missing note] -2. Browse through Collections.[missing note] \ No newline at end of file +1. See Quick Start. +2. Understand Notes. +3. Browse through Collections. \ No newline at end of file diff --git a/docs/User Guide/User Guide/Quick Start.md b/docs/User Guide/User Guide/Quick Start.md index 61ec6cd6b..b94b0372e 100644 --- a/docs/User Guide/User Guide/Quick Start.md +++ b/docs/User Guide/User Guide/Quick Start.md @@ -3,17 +3,17 @@ **Local only desktop/laptop** - Allows a single instance on a desktop and will save the notes locally on that desktop. -1. [Desktop installation](Installation%20%26%20Setup/Desktop%20Installation.md) +* Desktop Installation **Server with web only access** - Installs the application on the server and allows access from any web browser on any device, including mobile. -1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md) -2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional) -3. [PikaPods managed hosting](https://www.pikapods.com/pods?run=trilium-next) +1. Server Installation +2. Mobile Frontend (optional) +3. Third-party cloud hosting **Combination of server and desktop/laptop** - Install the application on both a server, for web access and data synchronisation, and desktop instance(s). This allows all the data to be stored on the server and either accessed from the web browser, or the desktop application. The desktop application will sync and store the data locally so that it can be used when offline. -1. [Server installation](Installation%20%26%20Setup/Server%20Installation.md) -2. [Mobile frontend](Installation%20%26%20Setup/Mobile%20Frontend.md) (optional) -3. [Desktop installation](Installation%20%26%20Setup/Desktop%20Installation.md) -4. [Synchronization](Installation%20%26%20Setup/Synchronization.md) \ No newline at end of file +1. Server Installation +2. Mobile Frontend (optional) +3. Desktop Installation +4. Synchronization \ No newline at end of file