Skip to content

Commit

Permalink
Add documentation for all features
Browse files Browse the repository at this point in the history
  • Loading branch information
khrj committed Aug 21, 2020
1 parent 5f32926 commit df3894b
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 32 deletions.
14 changes: 6 additions & 8 deletions vuepress-documentation/docs/features/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Features

## foo
This section elaborates on the features of TeleDrive

- Type: `string`
- Default: `/`

## bar

- Type: `string`
- Default: `/`
- [Signing in](signingIn) - Signing in to TeleDrive
- [Selecting a folder to place the synced folder in](syncedDir) - TeleDrive creates a synced folder - selecting and changing its location
- [Uploading files](uploadingFiles) - Automatically uploading files to Telegram
- [Restoring files](restoringFiles) - Restoring synced files
- [Resolving conflicts](restoringFiles) - Resolving upload conflicts when the cloud has a newer version of a file
15 changes: 9 additions & 6 deletions vuepress-documentation/docs/features/conflictResolver/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Resolving conflicts

## foo
## What are conflicts?

- Type: `string`
- Default: `/`
Conflicts occur when there is a newer version of a file already on saved messages,
but there is an older version of the file saved locally and TeleDrive is trying to back it up.
To prevent loss of newer data already stored on saved messages, a conflict is shown.

## bar
## Resolving conflicts

- Type: `string`
- Default: `/`
![Resolving conflicts](../../images/features.resolvingConflicts/conflict.png)

- **Fast-Forward local** will keep the version on the cloud (newer) in both places
- **Overwrite Cloud** will keep the local version (older) in both places
39 changes: 33 additions & 6 deletions vuepress-documentation/docs/features/restoringFiles/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,38 @@
# Restoring files

## foo
## Restoring files using TeleDrive

- Type: `string`
- Default: `/`
![Restoring files](../../images/features.restoringFiles/restoreFiles.png)

## bar
- Click restore

- Type: `string`
- Default: `/`
This will download all files backed up previously via TeleDrive
that are not present in the synced folder.
Existing files will not be re-downloaded

**For example:**

Device before restore:
```
TeleDriveSync ---- Folder1 ---- File1
```

Cloud before restore:
```
TeleDriveSync ---- Folder1 ---- File1
|
| ---- Folder2 ---- File2
```

Here, `Folder2` will be created and `File2` will be downloaded.

Device after restore:
```
TeleDriveSync ---- Folder1 ---- File1
|
| ---- Folder2 ---- File2
```

## Restoring individual files using Telegram's apps

In addition to restoring using TeleDrive, individual files can also be downloaded using Telegram's official apps
22 changes: 16 additions & 6 deletions vuepress-documentation/docs/features/syncedDir/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# Selecting a folder to place the synced folder in

## foo
## Selecting a folder

- Type: `string`
- Default: `/`
- After signing in, click 'Open'
- A system dialog will popup
- Select the folder which you want to place your synced folder in
- TeleDrive will create a folder called TeleDriveSync inside this folder

## bar
![Select a folder to sync](../../images/features.syncedDir/selectDir.png)

- Type: `string`
- Default: `/`
## Changing the folder

- Click 'Change'
- A system dialog will popup
- Select the folder which you want to place your synced folder in
- TeleDrive will create a folder called TeleDriveSync inside this folder
- TeleDrive will move all your synced files and then reopen with a delay of five seconds
- If TeleDrive doesn't automatically reopen, manually open it

![Changing the synced folder](../../images/features.syncedDir/changeDir.png)
15 changes: 9 additions & 6 deletions vuepress-documentation/docs/features/uploadingFiles/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
# Uploading files
TeleDrive adds folders and automatic folder watching to Telegram's saved messages

## foo
## Uploading files/folders

- Type: `string`
- Default: `/`
Uploading files and folders is as simple as copying/moving them
into TeleDriveSync inside the folder you [selected earlier](../syncedDir)

## bar
Since TeleDrive preserves folder hierarchy/structure, your folder structure will be preserved when you [restore](../restoringFiles) your files

- Type: `string`
- Default: `/`
## Changing uploaded files/folders

TeleDrive automatically scans and keeps track of your synced files and folders using SHA256 checksums.
Changing any files/folders inside the TeleDriveSync synced folder will update them on Telegram
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit df3894b

Please sign in to comment.