Live data from Hacker News

Show HN: Sodocan.js: Documentation Made Easy

sodocanjs.com

11–20 of 43 posts

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

#11
post #10

This looks really interesting, thanks for sharing. I'm finding it quite difficult to read through the main page however, as there's something going on with the scrolling. It's hyper-sensitive, then when there are animations on the page they play through before jumping me really far.

Thanks for pointing it out - the parallax scrolling on the landing page does seem to go a little too far. We'll fix it.

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

#12

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.

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

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

#13
I think it is a shame that most projects have only documentation in the form of one-liners for each function/variable/class. Those one-liners really don't mean much if you don't have a picture of the global architecture in your mind. That is far more important.

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

#14

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.

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!

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

#15
post #13

I think it is a shame that most projects have only documentation in the form of one-liners for each function/variable/class. Those one-liners really don't mean much if you don't have a picture of the global architecture in your mind. That is far more important.

This is one of the things I really like about Doxygen, the ability to automatically generate relationship maps between libraries and inheritance.

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

#17
post #15
post #13

I think it is a shame that most projects have only documentation in the form of one-liners for each function/variable/class. Those one-liners really don't mean much if you don't have a picture of the global architecture in your mind. That is far more important.

This is one of the things I really like about Doxygen, the ability to automatically generate relationship maps between libraries and inheritance.

This is something we plan to include in future releases as this is still a project in the early stage. We welcome your contribution!

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

#18
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 generated documentation would be crowdsourced?

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

#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 some do nothing)

- like button shows wrong cursor on hover

- buttons in settings dialog do nothing

- example has no code highlighting when present

Post reply on HN