Skip to content

Commit 4a1c94a

Browse files
leandroBorgesFerreiraLeandro Ferreira
leandroBorgesFerreira
and
Leandro Ferreira
authored
Documentation review (#486)
* Reviewing documents * Adding more videos * udpating documents * improving documentation --------- Co-authored-by: Leandro Ferreira <[email protected]>
1 parent 5d60b01 commit 4a1c94a

13 files changed

Lines changed: 1640 additions & 1861 deletions

File tree

‎documentation/writeopia_docs/docs/application/ai-commands/ai-commands.mdx‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import ReactPlayer from 'react-player'
2+
3+
# Using AI
4+
5+
Writeopia integrates seamlessly with AI agents to supercharge your writing process — whether you're brainstorming, editing, or exploring new ideas. You stay in control while AI works alongside you, completely offline if you choose.
6+
7+
*Key Features*
8+
Choose Your AI Agent: Pick from a list of available AI agents, or plug in your own.
9+
10+
Context-Aware Assistance: AI understands the current document context and provides tailored suggestions.
11+
12+
Offline Mode: AI works locally for full privacy — no internet connection needed.
13+
14+
Customizable Behavior: Configure how the AI should respond (e.g., tone, creativity, length).
15+
16+
## Generate Content
17+
**Note: This is only available in the Desktop apps**
18+
19+
To generate content with AI, you can click in the button "Prompt". It will take the selected messages and generate a reply based on it. If you don't select any message, it will create a the content of the line that your cursor is currently on.
20+
21+
Generating using text selection:
22+
23+
<ReactPlayer
24+
playing={false}
25+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/generate_ai_text_selected.mov"
26+
width="100%"
27+
height="600px" />
28+
29+
<br/>
30+
<br/>
31+
32+
It is possible to generate content without selecting lines of text, just by putting the cursor in a specific line.
33+
34+
<ReactPlayer
35+
playing={false}
36+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/generate_ai_by_line.mov"
37+
width="100%"
38+
height="600px" />
39+
40+
## Document AI commands
41+
There are many commands that generate content based on the whole text of the document. It is not necessary select a text to interact with it. You can just click in the button and the action will be triggered.
42+
43+
There are many options like: Generate a summary of the text, FAQ, tags, etc.
44+
45+
<ReactPlayer
46+
playing={false}
47+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/ai_summarize.mov"
48+
width="100%"
49+
height="600px" />

‎documentation/writeopia_docs/docs/application/ai/ai.mdx‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎documentation/writeopia_docs/docs/application/doc-commands/doc-commands.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import ReactPlayer from 'react-player'
2+
3+
# Document commands
4+
5+
Is it possible to select documents in the home menu. Once documents are selected, it is possible to add them to favorites, duplicate or deleted.
6+
7+
<ReactPlayer
8+
playing={false}
9+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/selecting_documents.mov"
10+
width="100%"
11+
height="600px" />

‎documentation/writeopia_docs/docs/application/exporting/exporting.mdx‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
import ReactPlayer from 'react-player'
2+
3+
# Exporting
4+
This document describes how to export workspaces and individual documents.
5+
6+
## Workspace
7+
It is possible to export your whole workspace or just individual documents. You can choose markdown or txt files.
8+
9+
<ReactPlayer
10+
playing={false}
11+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/exporting_documents.mov"
12+
width="100%"
13+
height="600px" />
14+
15+
## Individual Documents
16+
17+
It is also possible to export a single document. First navigate to the document and then select the export option.
18+
19+
<ReactPlayer
20+
playing={false}
21+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/exporting_single_document.mov"
22+
width="100%"
23+
height="600px" />
24+

‎documentation/writeopia_docs/docs/application/getting-started/ai/ai.mdx‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
import ReactPlayer from 'react-player'
2+
import ai_question from '../../../../static/vid/ai_question.mov'
3+
4+
5+
# AI commands
6+
7+
## Overview
8+
Writeopia integrates AI to enhance the writing experience by providing intelligent assistance while maintaining user privacy. Users can select from different AI agents to assist with brainstorming, editing, and content generation.
9+
10+
## Features
11+
- **Offline AI Support**: AI functionalities work offline to ensure privacy and security.
12+
- **Real-time Collaboration**: AI can assist in real-time without interfering with user input.
13+
- **Secure Processing**: Data remains private and is not sent to external servers.
14+
15+
## Using AI in Writeopia
16+
### Instaling Ollama
17+
In order to provide local AI features, Writeopia uses [Ollama](https://ollama.com/). Please go to Ollama website and:
18+
19+
- Install Ollama at ollama.com
20+
- Start Ollama in your computer.
21+
22+
Starting Ollama is necessary for Writeopia comunicate with it for the AI features.
23+
24+
### Configuring Writeopia for Ollama.
25+
Writeopia can use many different LLM models. You can choose which one you prefer. Bigger models will provide better results, but they are also heavier to use for your computer.
26+
You should experiment with the models and decides which one is the best for you. You can search for many at: [https://ollama.com/search](https://ollama.com/search).
27+
28+
If you are unsure about the model, no problem. We recommend that you start with `gemma3:4b`.
29+
30+
You can follow this video to install it:
31+
32+
<ReactPlayer
33+
playing={false}
34+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/download_model.mov"
35+
width="100%"
36+
height="600px" />
37+
38+
### Selecting an AI Agent
39+
If you download more models. You will be able to select different models are use them as you prefer.
40+
41+
<ReactPlayer
42+
playing={false}
43+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/select_model.mov"
44+
width="100%"
45+
height="600px" />
46+
47+
### Ask AI
48+
To ask AI you can move the cursor to the line that you would like to make a question of select all the lines that you would like to include in the query.
49+
50+
<ReactPlayer
51+
playing={false}
52+
controls
53+
url={ai_question}
54+
width="100%"
55+
height="600px" />
56+
57+
58+
<br/>
59+
60+
There are different way to ask AI to generate text. You can find more about it in the AI section.
61+
62+
## Future Enhancements
63+
We plan to add:
64+
- Presentations generated by AI
65+
- Semantic search
66+
- And more!

documentation/writeopia_docs/docs/application/sync-workspace/sync-workspace.mdx renamed to documentation/writeopia_docs/docs/application/getting-started/sync-workspace/sync-workspace.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
1+
import ReactPlayer from 'react-player'
2+
13
# Sync
24
You can sync your files locally by selecting a folder on your computer. To do this, go to Settings > Directory, choose your local folder.
35

6+
<ReactPlayer
7+
playing={false}
8+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/configure_workspace.mov"
9+
width="100%"
10+
height="600px" />
11+
412
## Saving documents
513
You can manually save your workspace locally by clicking the save icon. Your documents will be stored on your computer. If a saved document has a newer last-updated date, it won’t be overwritten, as the latest version always takes precedence in Writeopia.
614

15+
<ReactPlayer
16+
playing={false}
17+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/save_files_locally.mov"
18+
width="100%"
19+
height="600px" />
20+
721
## Syncing documents
822
Clicking the sync icon (a circular arrow symbol) will synchronize all files. Documents on the computer will be imported, while those in Writeopia will be saved locally. If a document exists in both locations, the newer version will take precedence.
23+
24+
<ReactPlayer
25+
playing={false}
26+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/sync_files_locally.mov"
27+
width="100%"
28+
height="600px" />

documentation/writeopia_docs/docs/application/drag-and-drop/drag-and-drop.mdx renamed to documentation/writeopia_docs/docs/application/importing/importing.mdx

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,35 @@ import ReactPlayer from 'react-player'
22
import drag_note from '../../../static/vid/drag_note.mov'
33
import drag_image from '../../../static/vid/drag_image.mov'
44

5-
# Drag and Drop
5+
# Importing
66

7-
You can drag and drop your files into Writeopia to create notes.
7+
There are ways to import information to Writeopia.
8+
9+
## Drag and Drop
810

11+
You can drag and drop your files into Writeopia to create notes.
912

10-
## Json Notes
13+
### Json Notes
1114
You can drop your notes to import them. The json must be the format of the notes of Writeopia.
1215

1316
<ReactPlayer playing={false} controls url={drag_note} />
1417
<br/>
1518

16-
## Images
19+
### Images
1720
You can also import images to create an image note. Simply drag your images into Writeopia to document them.
1821

1922
<ReactPlayer playing={false} controls url={drag_image} />
2023
<br/>
2124

22-
## Markdown
23-
Support for markdown is in development and will be added in the future.
25+
### Markdown
26+
You can also drag and drop markdown files.
27+
28+
## File picker
29+
30+
<ReactPlayer
31+
playing={false}
32+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/import_document.mov"
33+
width="100%"
34+
height="600px" />
35+
36+

‎documentation/writeopia_docs/docs/application/move-documents/move-documents.mdx‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import ReactPlayer from 'react-player'
2+
3+
# Move documents
4+
5+
It is possible to move documents by using drag and drop in the documents menu or to move inside the editor of documents.
6+
7+
## Move using drag and drop.
8+
9+
You can place documents inside folders, and you can also nest folders within other folders.
10+
11+
<ReactPlayer
12+
playing={false}
13+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/selecting_documents.mov"
14+
width="100%"
15+
height="600px" />
16+
17+
## Move using editor
18+
19+
You can also move documents from inside the document.
20+
21+
<ReactPlayer
22+
playing={false}
23+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/moving_from_editor.mov"
24+
width="100%"
25+
height="600px" />

‎documentation/writeopia_docs/docs/application/styling/styling.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import ReactPlayer from 'react-player'
2+
3+
# Styling
4+
5+
There are many ways to to style your document. It is possible to add highlight boxes for paragrapgs, change font style, add hightlight for pieces of code, etc.
6+
7+
It is possible to style the document in many ways. Use the side menu to change the styles, like this example using a highlight box:
8+
9+
<ReactPlayer
10+
playing={false}
11+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/hightlight_box.mov"
12+
width="100%"
13+
height="600px" />

‎documentation/writeopia_docs/docs/application/ui-commands/ui-commands.mdx‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,11 @@ The way to move content is to use the drag icon on the right side of it. Draggin
2626
**Web and desktop:** By pressing cmd+z (macos) or ctrl+z (windows/linux), , you can undo actions.
2727

2828
<ReactPlayer playing playing={false} controls url={undo_mobile} />
29+
30+
## Text selected - Mobile
31+
When text is selected, new options of commands become available to interact with the selected text.
32+
33+
<ReactPlayer
34+
playing={false}
35+
controls url="https://storage.googleapis.com/writeopia-resources/docusaurus/mobile_options.mov"
36+
height="600px" />

0 commit comments

Comments
 (0)