search

pelias / documentation

All things documentation for Pelias
Creative Commons Attribution 4.0 International
229 stars 99 forks source link

Updates to Get started topic #45

Closed rmglennon closed 9 years ago

rmglennon commented 9 years ago

Made the bullet list into paragraphs Add links to other topics Add examples of what you can do with search

Take a look at the next-to-last paragraph, in particular. I wasn't as clear on the meaning of some of the bullet points as I was reworking them.

rmglennon commented 9 years ago

In addition:

I was also wondering why the URLS have underscores in them, but realized it is for formatting.

orangejulius commented 9 years ago

These changes are all good and the paragraphs are much better quality than the bullet points. I have a question though. For a very high level overview doc like this one (I think this will often be one of the very first things people who are new to Pelias read), is it useful to have some bullet points that can quickly be skimmed over to get an idea of what you can do with this thing you're reading about?

rmglennon commented 9 years ago

Good points. Thanks, @orangejulius, for giving it a read.

Let me come up with about a couple of concise bullet points of what Search does and how to get started. If we're calling it a "get started", it should tell me that info up front. That can they link to other topics.

orangejulius commented 9 years ago

Those bullet points don't have to go in this document, now that I think about it. I'd love to hear your ideas for the best place. Maybe we keep the new text here as is, and add the bullet points to the index page?

rmglennon commented 9 years ago

Going to merge this. I have some work to do on the index page to make the docs site consistent. Will see if the bullet points belong here or in the index file.