WP-API / docs-v2

Documentation for version 2 of the API
http://v2.wp-api.org
58 stars 76 forks source link

Glossary for common terms #5

Open danielbachhuber opened 9 years ago

danielbachhuber commented 9 years ago

We should have a glossary for common terms (e.g. Resource, Controller, etc.) that can serve as an entry point to our documentation.

danielbachhuber commented 9 years ago

@pollyplummer any interest in kicking this off by putting together the list of terms we should define? You can edit the issue description to checkboxify it.

pollyplummer commented 9 years ago

Are we just shooting for some basic introductory terms here? If so, I've added a few above - happy to revise if we're trying to go for more specifics.

danielbachhuber commented 9 years ago

If so, I've added a few above - happy to revise if we're trying to go for more specifics.

This is a great start!

danielbachhuber commented 9 years ago

@pollyplummer I've done a first pass: http://v2.wp-api.org/#reference

Can you give that a read, and provide some direction on where you'd like to see clarification?

danielbachhuber commented 9 years ago

Hm, while the design of the site is worked out, this might be an easier direct link: https://github.com/WP-API/docs-v2/blob/gh-pages/_includes/reference/glossary.md

pollyplummer commented 9 years ago

Glossary is looking good! Do you think we should port over anything from our previous resources section (list of client libraries, authentication, tools, tutorials, etc) into the new Reference section alongside the glossary? Some of the other sections like Internals seem like they may not have changed much either and could be re-used.

danielbachhuber commented 9 years ago

Do you think we should port over anything from our previous resources section (list of client libraries, authentication, tools, tutorials, etc) into the new Reference section alongside the glossary?

Probably, yes. I'd like a little bit more validation on the information architecture we want to go with, and then we can go about porting with edits.

See #17