duckduckgo / duckduckhack-docs

DuckDuckHack Instant Answer documentation for developers
http://docs.duckduckhack.com
Other
78 stars 75 forks source link

"Tennis help" example no longer works #52

Closed spagy closed 7 years ago

spagy commented 8 years ago

The intro page gives the example of "tennis help" as a search query that should "show a perfect result, above any ads or regular links". Only thing is the tennis cheat sheet IA isn't triggered by the work "help" any more. So the example doesn't do anything.

This seems to be because the IA is a cheat sheet of the type "reference" and only "guide"s are triggered by the word "help".

This is an issue but I'm not sure whether the solution is to update the documentation or to change the IA trigger. It seems better, to me, to change the IA to make this work again. But I don't know whether the change that broke this was on purpose or not.

spagy commented 8 years ago

I've just had a look at the cheat sheet reference page. It has five examples in the cheat sheet ideas section. The link text and the search that is linked to sometimes different.

Link Text Activates IA Link Destination Activates IA
Regex help No regex help No
Anniversary meanings No anniversary help No
Cryptography terms and help No cryptography cheat sheet Yes
Harry Potter spells No harry potter spells cheat sheet Yes
Tennis info No tennis cheat sheet Yes

It looks like these IAs also need to be changed or the docs need to be updated to reflect the new implementation.

talsraviv commented 8 years ago

@GuiltyDolphin @moollaza @zachthompson thoughts? Is this good feedback for the cheat sheet template/trigger change, or is it something to account for in the docs?

Thanks @Spagy for bringing this up.

GuiltyDolphin commented 8 years ago

@Spagy Thanks for letting us know!

@talsraviv @zachthompson It looks like the 'anniversary' and 'tennis' cheat sheets aren't really 'help' cheat sheets so I think we should probably update the docs rather than add the trigger to them (I should have noticed this when I did the update a while back). I'm a bit more fency with regex... Thoughts @zachthompson ?

For the others, I think having link text differing from search term is fine, but changing the wording wouldn't hurt.

zachthompson commented 8 years ago

Some of these should probably still trigger:

The others we should update with different examples.

spagy commented 8 years ago

To me, it makes more sense for the text and search term to be the same. The context seemed to show that the text was an example search and the link a demonstration of that term.

There wouldn't be any negatives of the text and search term being the same would there?

GuiltyDolphin commented 8 years ago

@zachthompson I'm not sure those were triggering in the first place?

talsraviv commented 8 years ago

@Spagy agree with that

@GuiltyDolphin @zachthompson so far the foolproof thing has been to just change them all to cheatsheet. Not the best demonstration of the breadth of triggering but at least they work.

Is this something that suggests improvement to the cheat sheet triggering/templating mechanism?

GuiltyDolphin commented 8 years ago

@talsraviv There is a bunch of work in progress and discussion for improving the triggering! (See for example duckduckgo/zeroclickinfo-goodies#2781 and duckduckgo/zeroclickinfo-goodies#2777). Hopefully after resolution of those the triggering will be greatly improved (and we'll have more examples to use!).

zachthompson commented 8 years ago

The ignore feature doesn't directly help here and the categories are some time off. We have the ability to tweak triggers enough already to fix these.

GuiltyDolphin commented 8 years ago

@zachthompson Indeed we do!

What do you want to do about these ones then? Seeing as the only ones that aren't triggering when they are 'supposed' to use help perhaps we should move help into a more generic category? Or perhaps add it to reference?

zachthompson commented 8 years ago

@guiltydolphin yes, something along those lines. If you want to give it a shot and ping us in a pr we can see what it looks like.