Hacker News Reader

Comment by liujoycec | Hacker News Reader

If you would like to some real examples of documentation created using Sodocan.js, check out http://jesterswilde.github.io/hashids/ and http://liujoycec.github.io/jwt-simple/ . These are both created from the Blueprints template Sodone. These templates are also open-source, and we would love for you to help us improve them and add more templates!

View on HN

First impressions: feels rather unpolished

- text is too light and hard to read. Color contrast between text and background could be higher.

- up/down arrows do nothing

- plus button shows login dialog, but you can't register from there

- TP/EX/DE buttons are not in same order as their respective sections

- missing alt text on icon buttons, so it's not clear what they do (or rather, what they're supposed to do, since some do nothing)

- like button shows wrong cursor on hover

- buttons in settings dialog do nothing

- example has no code highlighting when present

Thanks for your input! Some button don't do anything right now because there's only one entry for the category, and certainly having tooltip will be able to help with the confusion the UI causes. We have opened github issues for the rest.

If pressing a button will do nothing due to lack of content, it should either be visibly disabled or hidden

IMHO it over-done with flat ui. pixel thin font, low contrast, etc etc.

The links on the side of both demos don't appear to do anything.

Thanks for pointing it out. This is a known bug that showed up in the deployment to gh-pages. We are currently looking into it.

Reply on news.ycombinator.com