← Back to team overview

elementary-dev-community team mailing list archive

Re: The elementary documentation weekend!


Yeah, even more customization guides are not worth the ink, but people
could collect the already existing ones together (so, posting them on
the gdoc and make sure that the author is using the CC-BY) and maybe
we can make one structured document out of it.

to the HIG: Maybe pics of good and bad interfaces (but nothing that
makes people cringe). I think using screenshots of some elementary
applications as a example.

@voldyman: I think there are some "HACKING" files in some projects. I
think it's a good idea to have them in all projects (maybe describing
how to compile/test and giving a short overview how the project is
build). I'll see if i can make a example for the greeter.
I think the best way to write documentation in the source is making a
short description for every class - what the class does and where it
is used. Also all variables/functions that are not obvious.

2013/11/6 Sergey "Shnatsel" Davidoff <sergey@xxxxxxxxxxxxxxxx>:
> I know of one item I'd really like to see documented because I don't
> understand it without docs. It's our CMake commands and config options. I
> never knew some projects have "make valadocs" command and nobody seems to
> know why it fails and what dependencies it's missing. It'd also be nice to
> include -DCMAKE_BUILD_TYPE=Debug and related generic trickery in the guide.
> Regarding the HIG, it'd be nice to include code examples/templates
> implementing the guidelines, where applicable.
> --
> Sergey "Shnatsel" Davidoff