docs-v2
docs-v2 copied to clipboard
Glossary for common terms
We should have a glossary for common terms (e.g. Resource, Controller, etc.) that can serve as an entry point to our documentation.
- [x] Resource
- [x] Controller
- [x] HTTP client
- [ ] JSON parser
- [x] HEAD request
- [x] GET request
- [x] Routes
- [x] Endpoints
- [ ] Meta Object
- [ ] Class
- [x] Schema
@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.
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.
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!
@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?
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
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.
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