microdotblog / help.micro.blog

Documentation for Micro.blog.
23 stars 8 forks source link

Adding example code #5

Open bellebethcooper opened 6 years ago

bellebethcooper commented 6 years ago

I'd like to add some more example code to the API docs, but I'm not sure the best approach right now, since the docs read like a single page blog post. @manton Do you have any thoughts on whether code blocks in-between paragraphs would be okay, or something else that might work better?

manton commented 6 years ago

I wasn't sure at first, because even though it's sparse I kind of like that you can see a quick glance of all the API endpoints. But you're right that it needs more examples. I think it's probably best to link off to separate pages with more detailed examples, similar to how the POST /micropub section is linked to a more detailed page about Micropub.