Skip to content

Commit 4885355

Browse files
authored
Fix documentation errors, broken links, and standardize to American English (#7599)
2 parents 0ae4def + 0cd6f0d commit 4885355

File tree

13 files changed

+30
-30
lines changed

13 files changed

+30
-30
lines changed

docs/User Guide/User Guide/AI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You will then need to set up the AI “provider” that you wish to use to creat
2121

2222
In the following example, we're going to use our self-hosted Ollama instance to create the embeddings for our Notes. You can see additional documentation about installing your own Ollama locally in <a class="reference-link" href="AI/Providers/Ollama/Installing%20Ollama.md">Installing Ollama</a>.
2323

24-
To see what embedding models Ollama has available, you can check out [this search](https://ollama.com/search?c=embedding)on their website, and then `pull` whichever one you want to try out. As of 4/15/25, my personal favorite is `mxbai-embed-large`.
24+
To see what embedding models Ollama has available, you can check out [this search](https://ollama.com/search?c=embedding) on their website, and then `pull` whichever one you want to try out. A popular choice is `mxbai-embed-large`.
2525

2626
First, we'll need to select the Ollama provider from the tabs of providers, then we will enter in the Base URL for our Ollama. Since our Ollama is running on our local machine, our Base URL is `http://localhost:11434`. We will then hit the “refresh” button to have it fetch our models:
2727

docs/User Guide/User Guide/Advanced Usage/Attributes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33

44
In Trilium, attributes are key-value pairs assigned to notes, providing additional metadata or functionality. There are two primary types of attributes:
55

6-
1. <a class="reference-link" href="Attributes/Labels.md">Labels</a> can be used for a variety of purposes, such as storing metadata or configuring the behaviour of notes. Labels are also searchable, enhancing note retrieval.
6+
1. <a class="reference-link" href="Attributes/Labels.md">Labels</a> can be used for a variety of purposes, such as storing metadata or configuring the behavior of notes. Labels are also searchable, enhancing note retrieval.
77

88
For more information, including predefined labels, see <a class="reference-link" href="Attributes/Labels.md">Labels</a>.
99
2. <a class="reference-link" href="Attributes/Relations.md">Relations</a> define connections between notes, similar to links. These can be used for metadata and scripting purposes.
1010

1111
For more information, including a list of predefined relations, see <a class="reference-link" href="Attributes/Relations.md">Relations</a>.
1212

13-
These attributes play a crucial role in organizing, categorising, and enhancing the functionality of notes.
13+
These attributes play a crucial role in organizing, categorizing, and enhancing the functionality of notes.
1414

1515
## Viewing the list of attributes
1616

docs/User Guide/User Guide/Advanced Usage/Custom Request Handler.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const {secret, title, content} = req.body;
1414
if (req.method == 'POST' && secret === 'secret-password') {
1515
// notes must be saved somewhere in the tree hierarchy specified by a parent note.
1616
// This is defined by a relation from this code note to the "target" parent note
17-
// alternetively you can just use constant noteId for simplicity (get that from "Note Info" dialog of the desired parent note)
17+
// alternatively you can just use constant noteId for simplicity (get that from "Note Info" dialog of the desired parent note)
1818
const targetParentNoteId = api.currentNote.getRelationValue('targetNote');
1919
2020
const {note} = api.createTextNote(targetParentNoteId, title, content);
@@ -37,7 +37,7 @@ This script note has also following two attributes:
3737
Let's test this by using an HTTP client to send a request:
3838

3939
```
40-
POST http://my.trilium.org/custom/create-note
40+
POST http://your-trilium-server/custom/create-note
4141
Content-Type: application/json
4242
4343
{
@@ -70,7 +70,7 @@ For more information, see [Custom Resource Providers](Custom%20Resource%20Provi
7070
REST request paths often contain parameters in the URL, e.g.:
7171

7272
```
73-
http://my.trilium.org/custom/notes/123
73+
http://your-trilium-server/custom/notes/123
7474
```
7575

7676
The last part is dynamic so the matching of the URL must also be dynamic - for this reason the matching is done with regular expressions. Following `customRequestHandler` value would match it:
@@ -85,4 +85,4 @@ Additionally, this also defines a matching group with the use of parenthesis whi
8585
const noteId = api.pathParams[0];
8686
```
8787

88-
Often you also need query params (as in e.g. `http://my.trilium.org/custom/notes?noteId=123`), you can get those with standard express `req.query.noteId`.
88+
Often you also need query params (as in e.g. `http://your-trilium-server/custom/notes?noteId=123`), you can get those with standard express `req.query.noteId`.

docs/User Guide/User Guide/Basic Concepts and Features/Navigation/Search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Note search enables you to find notes by searching for text in the title, conten
1313
To search for notes, click on the magnifying glass icon on the toolbar or press the keyboard [shortcut](../Keyboard%20Shortcuts.md).
1414

1515
1. Set the text to search for in the _Search string_ field.
16-
1. Apart from searching for words ad-literam, there is also the possibility to search for attributes or properties of notes.
16+
1. Apart from searching for words literally, there is also the possibility to search for attributes or properties of notes.
1717
2. See the examples below for more information.
1818
2. To limit the search to a note and its sub-children, set a note in _Ancestor_.
1919
1. This value is also pre-filled if the search is triggered from a [hoisted note](Note%20Hoisting.md) or a [workspace](Workspaces.md).

docs/User Guide/User Guide/Basic Concepts and Features/Notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ When you delete a note in Trilium, it is actually only marked for deletion (soft
2525

2626
Within (by default) 7 days, it is possible to undelete these soft-deleted notes - open the <a class="reference-link" href="UI%20Elements/Recent%20Changes.md">Recent Changes</a> dialog, and you will see a list of all modified notes including the deleted ones. Notes available for undeletion have a link to do so. This is kind of "trash can" functionality known from e.g. Windows.
2727

28-
Clicking an undelete will recover the note, it's content and attributes - note should be just as before being deleted. This action will also undelete note's children which have been deleted in the same action.
28+
Clicking an undelete will recover the note, its content and attributes - note should be just as before being deleted. This action will also undelete note's children which have been deleted in the same action.
2929

3030
To be able to undelete a note, it is necessary that deleted note's parent must be undeleted (otherwise there's no place where we can undelete it to). This might become a problem when you delete more notes in succession - the solution is then undelete in the reverse order of your deletion.
3131

docs/User Guide/User Guide/Basic Concepts and Features/UI Elements/Ribbon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you are using the _Fixed_ formatting toolbar, all the formatting buttons for
2020
* As a more advanced use, it's possible to change the note type in order to modify the [source code](../../Advanced%20Usage/Note%20source.md) of a note.
2121
* _**Protect the note**_ toggles whether the current note is encrypted and accessible only by entering the protected session. See [Protected Notes](../Notes/Protected%20Notes.md) for more information.
2222
* _**Editable**_ changes whether the current note:
23-
* Enters [read-only mode](../Notes/Read-Only%20Notes.md) automatically if the note is too big (default behaviour).
23+
* Enters [read-only mode](../Notes/Read-Only%20Notes.md) automatically if the note is too big (default behavior).
2424
* Is always in read-only mode (however it can still be edited temporarily).
2525
* Is always editable, regardless of its size.
2626
* _**Bookmark**_ toggles the display of the current note into the [Launch Bar](Launch%20Bar.md) for easy access. See [Bookmarks](../Navigation/Bookmarks.md) for more information.

docs/User Guide/User Guide/Collections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Collections
2-
Collections are a unique type of notes that don't have a content, but instead display its child notes in various presentation methods.
2+
Collections are a unique type of note that don't have content, but instead display their child notes in various presentation methods.
33

44
## Main collections
55

@@ -28,7 +28,7 @@ To change the configuration of a collection or even switch to a different collec
2828

2929
## Archived notes
3030

31-
By default, [archived notes](Basic%20Concepts%20and%20Features/Notes/Archived%20Notes.md) will not be shown in collections. This behaviour can be changed by going to _Collection Properties_ in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and checking _Show archived notes_.
31+
By default, [archived notes](Basic%20Concepts%20and%20Features/Notes/Archived%20Notes.md) will not be shown in collections. This behavior can be changed by going to _Collection Properties_ in the <a class="reference-link" href="Basic%20Concepts%20and%20Features/UI%20Elements/Ribbon.md">Ribbon</a> and checking _Show archived notes_.
3232

3333
Archived notes will be generally indicated by being greyed out as opposed to the normal ones.
3434

docs/User Guide/User Guide/Installation & Setup/Desktop Installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Trilium offers various startup scripts to customize your experience:
1616

1717
## Synchronization
1818

19-
For Trilium desktp users who wish to synchronize their data with a server instance, refer to the <a class="reference-link" href="Synchronization.md">Synchronization</a> guide for detailed instructions.
19+
For Trilium desktop users who wish to synchronize their data with a server instance, refer to the <a class="reference-link" href="Synchronization.md">Synchronization</a> guide for detailed instructions.

docs/User Guide/User Guide/Installation & Setup/Server Installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export TRILIUM_DATA_DIR=/home/myuser/data/my-trilium-data
3232

3333
### Disabling / Modifying the Upload Limit
3434

35-
If you're running into the 250MB limit imposed on the server by default, and you'd like to increase the upload limit, you can set the `TRILIUM_NO_UPLOAD_LIMIT` environment variable to `true` disable it completely:
35+
If you're running into the 250MB limit imposed on the server by default, and you'd like to increase the upload limit, you can set the `TRILIUM_NO_UPLOAD_LIMIT` environment variable to `true` to disable it completely:
3636

3737
```
3838
export TRILIUM_NO_UPLOAD_LIMIT=true

docs/User Guide/User Guide/Note Types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Note Types
2-
One core features of Trilium is that it supports multiple types of notes, depending on the need.
2+
One of the core features of Trilium is that it supports multiple types of notes, depending on the need.
33

44
## Creating a new note with a different type via the note tree
55

0 commit comments

Comments
 (0)