Clean up docs, fix links, remove Tutorials section for now

2026-07-01 03:09:43 +08:00 · 2017-10-20 11:28:03 +01:00
parent e729da8e01
commit 8ce9f2d4bb
5 changed files with 9 additions and 33 deletions
@@ -41,7 +41,3 @@ items:
    children:
      - title: FAQ
        url: /faq/
-  - title: Developer Tutorials
-    children:
-      - title: Developer Tutorials
-        url: /developer-tutorials/
@@ -25,7 +25,7 @@ https://domain.com/article-asset-slug/?commentId=0879edd7-1c4f-4918-abd2-a770db4

 ### Threading

-Talk supports by default 3 levels of threading, meaning each top-level comment has a depth of 3 replies; replies beyond that are not nested below the 3rd level. You can adjust this using the `TALK_THREADING_LEVEL` configuration variable. We don’t recommend deep threading because it can cause issues with styling, especially on mobile.
+Talk supports by default 3 levels of threading, meaning each top-level comment has a depth of 3 replies; replies beyond that are not nested below the 3rd level. You can adjust this using the [`TALK_THREADING_LEVEL`]({{ "/advanced-configuration/#talk_threading_level" | relative_url }})configuration variable. We don’t recommend deep threading because it can cause issues with styling, especially on mobile.

 You can style threaded comments using these CSS classes:

@@ -51,7 +51,7 @@ You can enable Talk to limit the character length for comments, for example, som

 ## Comment Reactions

-Talk comes with a `respect` button out of the box. Why a “respect” button, you ask? [Read more here](https://mediaengagement.org/research/engagement-buttons/). 
+Talk comes with a `respect` button out of the box. Why a “respect” button, you ask? [Read more here](https://mediaengagement.org/research/engagement-buttons/){:target="_blank"}. 

 We also have 2 more plugins, `like` and `love`, that you can turn on and experiment with on your own Talk install. 

@@ -113,7 +113,7 @@ The Staff user badge that shows when a commenter has an Admin, Moderator, or Sta

 The Featured comment badge shows when a comment has been featured.

-Another optional badge is the Subscriber badge (which is available as a [Recipe](/plugin-recipes/#recipe-subscriber). 
+Another optional badge is the Subscriber badge (which is available as a [Recipe]({{ "/plugin-recipes/#recipe-subscriber" | relative_url}}). 

 Badges are another easy part of Talk to customize by creating a new `tag`, then setting some rules for when it should show, and how the badge should be styled.

@@ -53,11 +53,11 @@ The History badge signifies comments that have been flagged because of a user’

 **Toxic**

-The Toxic badge signifies comments that are above the set Toxicity Probability Threshold. Note you must have `talk-plugin-toxic-comments` enabled. [Read more about Toxic Comments here](LINK).
+The Toxic badge signifies comments that are above the set Toxicity Probability Threshold. Note you must have `talk-plugin-toxic-comments` enabled. [Read more about Toxic Comments here]({{ "/toxic-comments/" | relative_url}}).

 **Suspect**

-The Suspect badge signifies comments that contain a Suspect Word. [Read more about Suspect Words here](LINK).
+The Suspect badge signifies comments that contain a Suspect Word.

 **Contains Link**

@@ -107,7 +107,7 @@ This shows the % of comments a commenter has had rejected by moderators, or auto

 **Reports**

-This shows if a commenter is a reliable flagger, an unreliable flagger, or a neutral flagger. [Read more about reliable and unreliable flaggers here](LINK).
+This shows if a commenter is a reliable flagger, an unreliable flagger, or a neutral flagger. [Read more about reliable and unreliable flaggers here]({{ "/trust/#reliable-and-unreliable-flaggers" | relative_url }}).

 **Moderating from this View**

@@ -145,7 +145,7 @@ Any usernames that have been reported will show in the Reported Usernames sub-ta
 All your team and commenters show in the People sub-tab. From here, you can manage your team members’ roles (Admins, Moderators, Staff), as well as search for commenters and take action on them (e.g. Ban/Un-ban, Suspend, etc.). 
 ### Configure

-See [Configuring Talk](LINK).
+See [Configuring Talk]({{ "/configuring-talk/" | relative_url }}).

 ## Moderating via the Comment Stream

@@ -17,7 +17,7 @@ Allows toggling of pre-moderating comments that have links.

 ### Ask Readers a Question & Question Icons

-Admins can choose to Ask Readers a Question in order to help guide the discussion. [Read more about why this is important on our blog](https://blog.coralproject.net/the-empty-box/).
+Admins can choose to Ask Readers a Question in order to help guide the discussion. [Read more about why this is important on our blog](https://blog.coralproject.net/the-empty-box/){:target="_blank"}.

 There are a selection of icons to display different messaging other than a question on a particular stream, like an announcement, or general information about the story.

@@ -38,7 +38,7 @@ A maximum comment length across the site.

 #### Comment Stream Description

-Description text that will appear above every comment stream site-wide. We recommend linking to your Code of Conduct or Community Guidelines. [Read tips on how to write a Code of Conduct here](https://guides.coralproject.net/create-a-code-of-conduct/).
+Description text that will appear above every comment stream site-wide. We recommend linking to your Code of Conduct or Community Guidelines. [Read tips on how to write a Code of Conduct here](https://guides.coralproject.net/create-a-code-of-conduct/){:target="_blank"}.

 #### Closed Stream Message

@@ -1,20 +0,0 @@
---
-title: Developer Tutorials
-permalink: /developer-tutorials/
---
-
-Coming soon!
-
-**How can I connect Talk to my own app/newsroom/blog’s auth?**
-
-**How can I display a story’s comment count externally?**
-
-**How can I add a moderation queue that filters by a tag?**
-
-**How can I manage Assets with Talk?**
-
-**How can I add a new translation for Talk?**
-
-**How can I style Talk?**
-
-**How do I submit a PR to Talk?**