buddycloud / buddycloud.com

buddycloud static site generation and gh_pages
http://buddycloud.com
Other
18 stars 18 forks source link

API page is unmaintainable #41

Closed vitoravelino closed 10 years ago

vitoravelino commented 10 years ago

Hard to find content, read and modify. Please use partials for the god sake.

Check https://github.com/buddycloud/buddycloud-styles/tree/master/docs/theme/templates for an example.

Do not exaggerate mixing Markdown with HTML. I suggest going with HTML because you are more flexible to do whatever you want to and stay as semantic as possible. There's a bunch of content being rendered not semantically but from editor's perspective it's beautiful to read and modify that part. Keep it simple. It's just horrible.

I didn't assign this to myself yet because I have other things with higher priority at the moment. If nobody do this, I'll do it later.

If you have any question, ask below.

imaginator commented 10 years ago

I agree the page isn't maintainable. There's lots of fixes I'd like to make to it but I'm going to hold off until bigger problems are fixed first.

imaginator commented 10 years ago

I think we've got this covered :)