3 ms·
Unless you're going to reference your blog-posts in the documentation and you're willing to keep such documentation updated, I'd strongly recommend you to focus
by znpy 10y ago
Unless you're going to reference your blog-posts in the
documentation and you're willing to keep such documentation
updated, I'd strongly recommend you to focus on improving
the documentation instead of writing long walls of text
on the internals.
If I imagine myself using your framework, well, I would be
very angry at you if I had to stop writing code, leave my
editor and go read your shilly-shally.
I would focus on:
1) Topics like "Application structure", "Application Deployment",
"Application command-line interface" (which at the moment of writing
are all just a "TODO").
2) Sample code. A 30 lines example is worth a thousand word blog post
3) More sample code. Ideally, one for every crucial part (cookies? session? middlewares?)
By the way: I see there are some examples, great! But add some more comments to your examples.
4) Blog post on internals.
I'd delay the blog post upon internals because I guess that since you'll be receiving a lot of feedback you might want to change things in the internals thus "invalidating" your blog posts.
P.s: congratulations on using doxygen so well! I wish more project had such a well done documentation!
p.p.s: I hope you won't find my comment rude or anything, I actually like
this project.
- rafaelmartins 10y agohey, thanks for the comment, it is far away from being rude :) blog posts were never the focus, they are mostly for myself, to remember how things work, as I don't work on the framework for some time, and need to have it fresh in mind to write proper docs. it may also help other people willing to help writing docs. also, whoever published balde website here in HN found it due to these blog posts, then they were worth already. :) and to be honest, I'd not publish the framework here in hacker news right now, I'd wait for documentation to be ready, but someone else couldn't wait, so... but you're right. the focus now is writing documentation. thanks
- ejanus 10y agoGreat job! But Balde first appeared on HN about 2 years ago, https://news.ycombinator.com/item?id=7765301 https://news.ycombinator.com/item?id=7765301.
- eka808 10y agoThere is something fantastic with the world of open source : you can enhance the bad parts of a project with your own skills to make it awesome. Basically, if you like the framework and there is no doc, Make a pain to yourself and contribute. p.p.s: I hope you won't find my comment rude or anything