Skip to content

Commit d6a3c6e

Browse files
committed
Clarify sync
1 parent 503726b commit d6a3c6e

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

docs/sync.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,21 @@ You can sync your content when adding a new challenge or project using the **Imp
1414

1515
This feature allows you to connect documentation from your open source repository on [GitHub](https://github.com), an online document at [Etherpad](http://etherpad.org), and many other collaboration platforms - see the list below.
1616

17-
When you **Edit** your project, you can find the **Readme** in the **Details** tab.
17+
![Screenshot of a README](images/screenshot_readme.png)
18+
19+
When you **Edit** your project, you can find the **Readme** link in the **Details** tab. Clear it to remove the Readme from your project.
20+
1821
Visit the [User guide](usage) to learn more about editing content in Dribdat.
1922

2023
## Staying in sync
2124

22-
Once you put the URL to your remote content into the **README** field when creating a new project. Or find it in the **Details** editor on an existing challenge or project, the content will be fetched, and you will be notified if there are any errors.
25+
Once you put the URL to your remote content into the **Readme** field when creating a new project, the content will be fetched, and you will be notified if there are any errors.
2326

24-
From time to time - such as when writing a Post - the data will be refreshed. You can use the **Sync** (synchronise) button on the bottom of your project page to refresh your changes at any time. Administrators can also selectively Sync projects, or all at once in the project list.
27+
Note that for source code repositories, some additional content is fetched, such as links to source code or demo. You can modify this in the **Details** editor.
2528

26-
Even if you have a Readme, you can still _Edit_ your project to add notes or answer questions relevant to the event you are at, and _Details_ to tweak the Contact, Download, Source, Image links and more.
29+
From time to time - such as when writing a Post - the data will be refreshed. You can use the **Sync** (synchronise) button on the bottom of your project page to refresh your changes at any time. Administrators can also selectively Sync projects, or all at once in the project list.
2730

28-
Note that for source code repositories, some additional content is fetched, such as links to source code or demo. To clear the README, just remove the link.
31+
Even if you have an externally hosted Readme, you can still _Edit_ your project to add notes or answer questions relevant to the event you are at, and _Details_ to tweak the Contact, Download, Source, Image links and more.
2932

3033
## Supported sites
3134

@@ -43,7 +46,7 @@ Leave us [an issue](https://codeberg.org/dribdat/dribdat/issues) or drop into th
4346

4447
### Using Google Docs
4548

46-
A special note if you are trying to attach a document from Google Drive.
49+
A special note if you are trying to attach a document from Google Drive.
4750

4851
If you want to use Google Slides to make a presentation, it is best to Publish to Web, and copy the Embedding link (just the URL) as your Presentation link. The following applies to attaching the contents of Google Docs:
4952

0 commit comments

Comments
 (0)