search

duckduckgo / duckduckgo-documentation

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

clarify "erase any pre-filled content" #257

Closed zekiel closed 9 years ago

zekiel commented 9 years ago

On the cheat sheets page: https://duck.co/duckduckhack/goodie_cheat_sheets there's a line:

"Erase any pre-filled contents, and enter the values for your cheat sheet using the cheat sheet JSON syntax. "

but we didn't yet tell the user to use an example json file. So when you, "create a new file" it will create itself as a blank file. We should probably provide a reference to copy+paste and then use the Syntax file to help annotate.

OR comment out vim.json in the same style as the syntax guide.

thoughts? //cc @talsraviv

zekiel commented 9 years ago

to clarify my own comment :) I'm saying that we reference the Syntax guide and the Vim.json file but not in the (seemingly) correct order.

talsraviv commented 9 years ago

I see what you're getting at. I wrote this to be as beginner-friendly as possible, so using the Codio File > New File menu, you get this when the file extension is .json:

screen shot 2015-06-01 at 11 33 22 am

So I wrote to erase anything Codio might pre-fill

talsraviv commented 9 years ago

Maybe there's a way to modify the main DDH codio project that gets cloned to prevent this?

talsraviv commented 9 years ago

cc @moollaza

zekiel commented 9 years ago

i just meant in the docs :)

moollaza commented 9 years ago

We could definitely create a template for the docs. One step further would be to improve DuckPAN: i.e. duckpan new --cheatsheet or similar, which generates a named JSON file in the CheatSheets dir?

talsraviv commented 9 years ago

Ah gotcha. Yeah duckpan is a cool idea for down the road. What I'll do for now is encourage contributors to copy the code block and replace their values (and comment out ellipses and so on that would break it)