search

duckduckgo / duckduckgo-documentation

Deprecated - OLD - See Below
Other
44 stars 60 forks source link

Common paradigms and patterns should be encouraged more! #145

Open mintsoft opened 9 years ago

mintsoft commented 9 years ago

We're starting to build up a couple of nice work patterns around Goodies and Spices wrt to the "best way" to handle things; for example the NumberStyler and Dates role things.

I think it'd be nice if the docs show people what's available for reuse easily in a more focused way; currently I think users have to be hunting for them already to actually find them. Most people probably end up writing their own, do the PR and then get told "btw this just works, all your labour can be scrapped!"; which seems kinda wasteful.

What do others think? Some sort of "common practises" section?

Example: https://github.com/duckduckgo/zeroclickinfo-goodies/pull/734#discussion_r20050696

@mwmiller @moollaza @jagtalon @mattr555

moollaza commented 9 years ago

Yes! I agree, we can add it to the resources and add some mentions of it in the setup process - I'm currently working on a PR that reflows the intro to development and down the line there will be a larger redesign to the docs (which I can't wait for) because the very linear flow and the collapsed sidebar doesn't help to create awareness of what other pages/resources are available, which is a problem

mattr555 commented 9 years ago

We should totally have this. We already have the documentation on the DDG Namespace which has a lot of reusable functions, so I guess the idea is to make these resources more obvious throughout the tutorial and docs. Maybe like "Wait! Before you implement that common task, check to make sure it hasn't been done for you in the {perl roles,DDG namespace}!"

mintsoft commented 9 years ago

Maybe like "Wait! Before you implement that common task, check to make sure it hasn't been done for you in the {perl roles,DDG namespace}!"

Exactly! I think better visibility is all that's needed