Decide on structure / contents of docs menu

[fakedarren]

API reference menu is the same as what we currently have - almost 1:1 with the components themselves.

I wanted to make the menu structure for docs better by grouping / naming them closer to the functions they perform eg

• Element
  • Traversal
  • Creation
  • Adding events
• Fx
  • Creating an Fx
  • Chaining animations
• Request
  • Simple Ajax requests
  • Working with JSON

Or similar.

[fakedarren]

https://github.com/fakedarren/mootools-website/wiki/Proposed-new-Docs-menu-structure

@timwienk, @arian, @nfq, @ibolmo, @darkwing, @w00fz, @anutron, what do you think of Elements so far? On the right track?

[anutron]

Looks good to me. My only other suggestion would be a see-also section where we talk about extending element and available plugins that do so (Fx, Request, etc).

[darkwing]

I love it!

David Walsh

http://davidwalsh.name http://twitter.com/davidwalshblog http://buysellads.com/buy/detail/1687 http://scriptandstyle.com http://github.com/darkwing http://wynq.com

On Mon, Oct 10, 2011 at 5:35 PM, Aaron Newton < reply@reply.github.com>wrote:

Looks good to me. My only other suggestion would be a see-also section where we talk about extending element and available plugins that do so (Fx, Request, etc).

Reply to this email directly or view it on GitHub:

https://github.com/fakedarren/mootools-website/issues/24#issuecomment-2353231

[fakedarren]

@anutron: see-also would be covered on a page by page basis by Solr, which will be able to automatically pull in a list of related content from any source we add to it, so we have that well and truly covered.

I'll keep working on this list then (help welcome!) until we have a complete list, and I will update the repo when it's at say 80% so people can actually have a play with it and see if it feels right.

[ibolmo]

This is a good step forward, and seems aligned to the "Book" idea: https://github.com/fakedarren/mootools-website/wiki/Site-Content-(Outline)

[fakedarren]

OK, I'm going to move this to the end ('odd jobs') because we haven't got the code yet :)

And as it stands, we should look for this site to be used for the new version, not a 1.x. And restructuring documentation for 'old' code is not worthwhile.

If we do go live with 1.x then we can simply rename 'Element.Style' 'styling elements' etc but you don't really get the benefit - it is Element.md that really needs to be broken up.

I was thinking you could have an Element.md which contains stuff like:

Element
=======

###include Element.Traversal.md
###include Element.Manipulation.md

That way we can have the 1-1 docs-to-code we want but can also break it up, API view vs 'Docs' / 'Book' view.