31–40 of 43 posts
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! :)
Am I the only one, who cannot believe that websites made by (web)developers use scroll hijacking?
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…
IMHO it over-done with flat ui. pixel thin font, low contrast, etc etc.
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.
Also, is there a demo view, as to what the generated documentation looks like?
Great project!
Earlier quoted context omitted.
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.
I see. But shouldn't documentation in the source code be the "only source of truth". Say I upload the documentation JSON file, and somebody else edits it online. If I re-generate the documentation from the same source code, I will no longer be able to push the changes, right? Also, is there a demo view, as to what the generated documentation looks like? Great project!
I was curious about some of the tech stack since there is a section on the landing page. I recognize most of the logos, but some I don't. It'd be nice if there were links or even names on hover, instead of just one big image.
But documentation is only part of the story. You really need a full team of smart technical people, writers, and "dev evangelists" that are creating sample projects, tutorials, quick start guides, and giving feedback to the engineers on how easy their APIs are to use and understand. You can't just auto-generate docs and think you're done.
That said, I much prefer open source projects to be organized logically and the code to be "self-documenting". Don't make me wade through mounds of API documentation when I usually just end up going to the source anyway to figure out what's going on.
Earlier quoted context omitted.
I see. But shouldn't documentation in the source code be the "only source of truth". Say I upload the documentation JSON file, and somebody else edits it online. If I re-generate the documentation from the same source code, I will no longer be able to push the changes, right? Also, is there a demo view, as to what the generated documentation looks like? Great project!
Thanks! To see a demo, please visit http://jesterswilde.github.io/hashids/ and http://liujoycec.github.io/jwt-simple/ . As some other people have pointed out, the font is too thin and the contrast is difficult to read which is fixed by the most recent PR to the main repo (the demos haven't been updated yet). Please check back for the updated demos!