Any Thoughts on API Documentation So Far?


(Jordan H) #1

Note: This discussion was imported from Loomio. Click here to view the original discussion.


(Jordan H) #2

This is what I’ve started so far with the documentation.

I feel the documentation should be layout-based as opposed to control-flow-based (I guess that’s how you would describe the other way of doing it) since a web page is visual.
Though hacking Diaspora* I found myself asking “How do I change X? Where are the controls for X in the code?”

Any other thoughts?


(Jonne Haß) #3

Hm, I’m not sure what “API” you want to document there, so I can’t say much more.

The other thing is that we’re currently investigating to move the wiki to http://wiki.diaspora-project.org or something similar, not sure if it’s worth the effort to start a whole new section in the old one.

Btw. one doesn’t use a-tags as anchors anymore but just plain IDs, see https://developer.mozilla.org/en-US/docs/HTML/Element/a#attr-name :wink: