Comment by tuctrohs on 01/08/2020 at 12:49 UTC

2 upvotes, 1 direct replies (showing 1)

View submission: Introducing Flair_Helper

A few suggestions for /u/Blank-Cheque and /u/justcool393 :

• It's a little hard to find the index to the wiki pages, other than from this post. I suggest a linke

• A link from https://www.reddit.com/r/Flair_Helper/wiki/index[1] to https://www.reddit.com/r/Flair_Helper/wiki/tutorial[2] so you can get there from the wiki tab, and,

1: https://www.reddit.com/r/Flair_Helper/wiki/index

2: https://www.reddit.com/r/Flair_Helper/wiki/tutorial

• A link from the bottom of each tutorial page back to the main page of the tutorial.

• Note that it doesn't work on mod posts, if I'm correct about that limitation.

• There's a discrepancy between the format shown on the examples page and that given in the template that the bot PM's to the mod: flair is in double quotes in one and not in the other. That probably doesn't matter but can be a source of confusion. (I wasted time trying both when I was troubleshooting.)

• Another possible confusion: Because of markdown, there's a difference between the source text in the configuration wiki, the way it's rendered when you view the wiki page, the way the examples are rendered in the tutorial wiki, and the source code used in the tutorial wiki. It seems that one wants the source of one to match the rendering of the other. You might think that's obvious, but when someone is troubleshooting, it's little things like that that they need to start questioning and clear documentation helps.

Replies

Comment by Blank-Cheque at 01/08/2020 at 13:00 UTC

2 upvotes, 1 direct replies

I suggest a link ...

Good point! Done.

Note that it doesn't work on mod posts, if I'm correct about that limitation.

It will not work on your own posts due to a limitation of reddit: flairing one's one post does not count as a mod action, even if you use a mod flair to do it. It will still work if you flair another mod's post.

There's a discrepancy between the format shown ...

You are correct that it doesn't make a difference in this case. Users of Flair_Helper are expected to familiarize themselves with YAML syntax to some degree and the differences are intended to demonstrate that there are multiple ways to write the same thing in YAML. Perhaps it would help to put variations within the examples page itself.

Because of markdown, there's a difference between ...

Users are similarly expected to be familiar with markdown syntax, especially since they're necessarily reddit mods. There isn't really anything I can do to change the way the wiki page renders, so I'm not totally sure what you're suggesting here.