Skip to content

Commit 25ac9e2

Browse files
Copiloteliandoran
andcommitted
Fix spelling, grammar, and broken links in documentation
Co-authored-by: eliandoran <[email protected]>
1 parent 3b02eb8 commit 25ac9e2

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
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/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/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/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

docs/User Guide/User Guide/Troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Troubleshooting
2-
As Trilium is currently in beta, encountering bugs is to be expected.
2+
While Trilium is actively maintained and stable, encountering bugs is possible.
33

44
## General Quick Fix
55

@@ -21,7 +21,7 @@ TRILIUM_START_NOTE_ID=root ./trilium
2121

2222
## Broken Script Prevents Application Startup
2323

24-
If a custom script causes Triliumto crash, and it is set as a startup script or in an active [custom widget](Scripting/Custom%20Widgets.md), start Triliumin "safe mode" to prevent any custom scripts from executing:
24+
If a custom script causes Trilium to crash, and it is set as a startup script or in an active [custom widget](Scripting/Custom%20Widgets.md), start Trilium in "safe mode" to prevent any custom scripts from executing:
2525

2626
```
2727
TRILIUM_SAFE_MODE=true ./trilium

docs/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,27 @@ Trilium Notes is a powerful, feature-rich note-taking application designed for b
2121

2222
<div class="grid cards" markdown>
2323

24-
- :material-rocket-launch-outline: **[Quick Start Guide](User%20Guide/quick-start.md)**
24+
- :material-rocket-launch-outline: **[Quick Start Guide](User%20Guide/User%20Guide/Quick%20Start.md)**
2525

2626
Get up and running with Trilium in minutes
2727

28-
- :material-download: **[Installation](User%20Guide/installation.md)**
28+
- :material-download: **[Desktop Installation](User%20Guide/User%20Guide/Installation%20%26%20Setup/Desktop%20Installation.md)**
2929

30-
Download and install Trilium on your platform
30+
Download and install Trilium on your desktop
3131

32-
- :material-docker: **[Docker Setup](User%20Guide/docker.md)**
32+
- :material-server: **[Server Installation](User%20Guide/User%20Guide/Installation%20%26%20Setup/Server%20Installation.md)**
3333

34-
Deploy Trilium using Docker containers
34+
Deploy Trilium as a server
3535

36-
- :material-book-open-variant: **[User Guide](User%20Guide/index.md)**
36+
- :material-book-open-variant: **[User Guide](User%20Guide/User%20Guide.md)**
3737

3838
Comprehensive guide to all features
3939

40-
- :material-code-braces: **[Script API](Script%20API/index.md)**
40+
- :material-code-braces: **[Script API](Script%20API/index.html)**
4141

4242
Automate and extend Trilium with scripting
4343

44-
- :material-wrench: **[Developer Guide](Developer%20Guide/index.md)**
44+
- :material-wrench: **[Developer Guide](Developer%20Guide/Developer%20Guide/Environment%20Setup.md)**
4545

4646
Contributing and development documentation
4747

@@ -80,14 +80,14 @@ Trilium Notes is a powerful, feature-rich note-taking application designed for b
8080

8181
## Getting Help
8282

83-
- **[FAQ](support/faq.md)** - Frequently asked questions
84-
- **[Troubleshooting](support/troubleshooting.md)** - Common issues and solutions
83+
- **[FAQ](User%20Guide/User%20Guide/FAQ.md)** - Frequently asked questions
84+
- **[Troubleshooting](User%20Guide/User%20Guide/Troubleshooting.md)** - Common issues and solutions
8585
- **[Community Forum](https://github.com/triliumnext/trilium/discussions)** - Ask questions and share tips
8686
- **[Issue Tracker](https://github.com/triliumnext/trilium/issues)** - Report bugs and request features
8787

8888
## Contributing
8989

90-
Trilium is open-source and welcomes contributions! Check out our [Contributing Guide](Developer%20Guide/contributing.md) to get started.
90+
Trilium is open-source and welcomes contributions! Check out our [GitHub repository](https://github.com/triliumnext/trilium) to get started.
9191

9292
## License
9393

0 commit comments

Comments
 (0)