feat(docz): ordering menu on doczrc

[mpivaa]

Ordering menu on doczrc

Based on http://feedback.docz.site/roadmap/p/managing-menu-order-on-doczrc

Pre-merge checklist

• Order menu through doczrc
• Update docs

[pedronauck]

Great job @mpivaa, you're doing a really great work, thanks 👏

So, about this task, sorry to tell that just now, but I was thinking of something a little bit different and maybe a little bit complicated too...

The idea is to use the menu property` to create the hierarchy and be able to add some custom properties for each one:

export default {
  menu: [
    'Getting Started',
    {
      name: 'Components',
      menu: [
        'Alerts',
        'Button',
        ...
      ],
    },
    {
      name: 'Github',
      route: 'https://github.com/pedronauck/docz'
    }
  ]
}

But this is can be kinda a breaking change because of today when we use <Docs> component inside a theme to get the array of menus, this array just has strings. And to keep maintainability, we should need to use the menu to ordering and populate the data.

[pedronauck]

I think that use Infinity like the sortOrder method in this link is better:
https://github.com/mdx-js/mdx/blob/master/docs/_app.js#L49-L60

[mpivaa]

I thought about Infinity too, I will change

[mpivaa]

I think these changes makes sense, but definitely they are breaking changes, maybe we should always pass an object as the menu and the theme handles how to present it?

[pedronauck]

Yeah, for sure @mpivaa, this will be a breaking change definitely 😕 So, I think that is best we keep baby steps here and release this feature like people want, in a simple way and. Maybe leave this change to release in v1.0 and we can put some others nice things together ✌️

[hnordt]

@pedronauck I can see you are not using menu in doczrc.js. Why you don't allow passing menu and keep the current behavior when it's omitted. It would prevent a breaking change.

[mpivaa]

@hnordt It would break if the user defines menu in doczrc.js but the theme is not prepared for an object.

[mpivaa]

@pedronauck I've changed the config interface so it looks like:

export default {
  menu: [
    'Getting Started',
    {
      name: 'Components',
      docs: [
        'Alerts',
        'Button',
        ...
      ],
    }
  ]
}

That way when we change the implementation of Menu to allow objects, it will not break old configurations.

[actuallyReallyAlex]

If I were to try and implement this now, would it work? v0.11.2

[miketdonahue]

What version will this be released on @pedronauck @mpivaa ?

[pedronauck]

Will be released in the v0.12.0 @sidewalksalsa, we have just some bugs and performance improvements to solve before release this version 🙏