neos / documentation

Base for documentation discussions/issues, WIP
2 stars 0 forks source link

the "Features" area of the Manual should be moved somewhere else #36

Open skurfuerst opened 5 years ago

skurfuerst commented 5 years ago

To me, the "Features" area of the manual should be moved somewhere else - https://docs.neos.io/cms/manual/features

I feel these points probably should become top level points directly in "Manual" (how to do SEO, how to build forms, ...)

maxstoyanov commented 5 years ago

We added this section because those are not core features rather close-to-core and did not want to give the impression that those can not be replace or are irrevocably baked in.

I see that we missed that mark and those three pages might be better of being direct children of the Manual page.

skurfuerst commented 5 years ago

@maxstoyanov I am sure we can highlight this on top of these sections :) :) Thanks for your comment!

rolandschuetz commented 5 years ago

The reasoning of the page "features" was that we just have too many to have them all on the same level. We discussed quite long if the page should be called feature or something like "additional features.

This is the place where things like search should be added, so they are at least 6 menu entries and this is too much for the current structure...

I'm happy for any ideas on how to restructure it.

rolandschuetz commented 5 years ago

Should we change something here? https://docs.neos.io/cms/manual/features

skurfuerst commented 5 years ago

@rolandschuetz I personally still don't understand the Features category; but if you all want to keep it then I won't block that decision :-) I'd personally move the content one level up.

rolandschuetz commented 5 years ago

When we move Features one level up (and probably there will come more) we would have a total of 23 items directly below "Manual". Any ideas about how we could remove it then?

skurfuerst commented 5 years ago

Hey @rolandschuetz,

for me personally, having about 20 second level menu items is not a problem IMHO. As an analogy, to me it is like a book with 20 main chapters.

Some lessons I have learned while writing the Extbase book, by receiving regular feedback of the professional "lektor" (don't know the word in english) is:

I know these lessons are not 1:1 applicable to the Neos docs; but for me this could mean:

(I know this is not fully thought out -- but maybe it can be used as a starting point for discussion :) )

Thanks again for all your great work on the documentation - I love it ❤️

All the best, Sebastian