New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

formatting and style of the website could be better #118

Open
mhaberler opened this Issue May 30, 2016 · 4 comments

Comments

Projects
None yet
3 participants
@mhaberler
Copy link
Member

mhaberler commented May 30, 2016

this is an anchor issue about the web mechanics perspective:

  • which style/fonts/layout/css etc should we use?
  • which source highlighting style is best
  • do we need an epub format of the website?

we need a bit of a style guide for writing documents and man pages!

@luminize

This comment has been minimized.

Copy link
Member

luminize commented Aug 8, 2016

@mhaberler I think you can tick off "source highlighting". Regarding style guide, how about something like this for the manpages luminize@0c6199e (to get some feeling on usability / readability) or @ArcEye does this completely mess up all the work that you already did with instcomp and mank ?

  • using tables gets a (IMO) better structured overview of the pins, type, direction and description
  • syntax makes usage clear
@ArcEye

This comment has been minimized.

Copy link
Contributor

ArcEye commented Aug 9, 2016

It won't mess up instcomp and comp, because I won't be changing it !
All of man3 and man9 need to display properly before I even think of changing something that produces a fully readable page currently.
Tables are catered for specifically, but there are only 2 or 3 components that use them.

Mank just displays a text rendered html page converted from the asciidoc.
I seem to remember having to change the existing tables so that they displayed correctly in a browser AND mank, so you will need to check that.

@luminize

This comment has been minimized.

Copy link
Member

luminize commented Aug 11, 2016

It wasn't necessarily trying to change things, more as a thought on how to better display information. See https://snag.gy/06E5va.jpg and https://snag.gy/w2TkP4.jpg should give you an idea without having to render said branch.

@ArcEye

This comment has been minimized.

Copy link
Contributor

ArcEye commented Aug 12, 2016

Those look good, but you would need to test the html in elinks (or open the asciidoc with mank) to see how they are rendered.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment