Live data from Hacker News

Show HN: Sodocan.js: Documentation Made Easy

sodocanjs.com

21–30 of 43 posts

Re: Show HN: Sodocan.js: Documentation Made Easy

#21

I'm trying understand what this fulfills. I understand it extracts documentation from comments, and writes them to a JSON file. There are have been countless tools to do this. But the difference of Sodocan is that it then sends these JSON files to an API server, which hosts these documentations? So basically instead of using JSDoc + static site generator, one would use this method? And the benefit would be that the g…

That is right - so the idea is that the project owners don't have to be the only ones to maintain the documentation, instead the users can contribute as well. The same project hosted at different places all point to the same place in the database. We also plan to add version control.

Re: Show HN: Sodocan.js: Documentation Made Easy

#22
post #14

Earlier quoted context omitted.

The parallax scrolling on the landing page does seem to go a little too far. We'll fix it soon. Thanks!

Not sure it's related to the parallax. It's more about the scroll hijacking which makes it very unpleasant on Mac using a Magic Mouse. It's really obviously broken so I'm pretty sure no-one in your team has one or else this wouldn't have been shipped. The product seems interesting anyway!

Yup, it makes for a really horrible experience - like wading through treacle. I think this page officially marks the point at which scroll-hijacking has to stop!

Re: Show HN: Sodocan.js: Documentation Made Easy

#23
post #20

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!

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…

[deleted]

Re: Show HN: Sodocan.js: Documentation Made Easy

#24
post #20

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!

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…

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.

Re: Show HN: Sodocan.js: Documentation Made Easy

#25

A shame that the page has to hijack the scroll functionality, it makes for a very unpleasant "lumpy" feeling scrolling. Chrome Version 46.0.2490.80 (64-bit) on OS X Yosemite.

Agreed. I couldn't even scroll with my mouse wheel...I had to click and drag the bar. Chrome 46.0.2490.86 on Windows 7.

Re: Show HN: Sodocan.js: Documentation Made Easy

#26
Ok, what is the unwanted side-effect for the user? Since i cannot see pricing info or such - how do you monetize? Which part of my soul - as a user - do i sell by using the service?

And: The service looks nice - my way of asking questions does not imply a bad impression.

Re: Show HN: Sodocan.js: Documentation Made Easy

#27
post #26

Ok, what is the unwanted side-effect for the user? Since i cannot see pricing info or such - how do you monetize? Which part of my soul - as a user - do i sell by using the service? And: The service looks nice - my way of asking questions does not imply a bad impression.

[deleted]

Re: Show HN: Sodocan.js: Documentation Made Easy

#28
post #26

Ok, what is the unwanted side-effect for the user? Since i cannot see pricing info or such - how do you monetize? Which part of my soul - as a user - do i sell by using the service? And: The service looks nice - my way of asking questions does not imply a bad impression.

This is an open source project hence there is absolutely zero monetization. That said, please fork us and contribute! :)

Re: Show HN: Sodocan.js: Documentation Made Easy

#30

I find it frustrating to read the documentation demos you have created. Low contrast and poor choice of font. This is what it looks like on Chrome in Windows 7: http://i.imgur.com/ArFcnM2.jpg

Another github user has submitted a pull request to fix the contrast. We will update the demos momentarily. Thanks!
Post reply on HN