Code review comment for ~cjwatson/launchpad:doc-vanilla

Revision history for this message
Jürgen Gmach (jugmac00) wrote (last edit ):

A couple of remarks
- I really want a (short) overview of the used tech stack, the necessary tools we need to install, some description, link to the source, command steps to reproduce this result, a description what to do when we need to change this; I hope this will not take you more than 15 minutes, but this will save other engineers hours fiddling around if you have a day off; This info could straight go into a new bullet point of the explanation section.
- If possible, the bottom link "Show source" should point to the page on code.launchpad.net/..., even though we lack the feature to directly edit pages in the browser; at least you know the path to the file then; I never found value in a "show source" link, but maybe I miss something; if it is not possible to link to the real source, I would not mind removing the link
- I assume we as a team are the main users of the development documentation; the 6 items of "Overview" take 90% of the loading screen, and I will basically never read those again; the most important information is in the "Contents" section, which I will access regularly; I'd like to have these two sections swapped
- I think it is a pity that index page now is only a high level menu, and the links to e.g. the how-tos are no longer present on the first page, so I need two clicks now to get to an article, but I think this would have become necessary at one point anyway, ie when we grow many more articles
- I think we can agree, that the new theme is more modern, and the current menu of the old site doesn't look good, but ... the new theme is harder for my eyes, especially the low font-weight; with font-weight 400 readability would be so much better
- this leads to my first question: Do we need to switch to this theme, ie company policy? Are we allowed to make modifications?
- How is this theme related to https://vanillaframework.io/ ?
- The search bar is ... big.
- I don't like that we now have basically three menus on the main page - I like the elegance of the one on the right - I do not like the one on the left as there are things mixed which do not go together; I would prefer to have links to Overview, Contents, and Project and Community; the links on the left are confusing
- I think there is some potential in the top menu... can we have the four diataxis sections there?

I consider my first bullet point a real blocker.

review: Needs Fixing

« Back to merge proposal