elementary-dev-community team mailing list archive

["Sergey \"Shnatsel\" Davidoff" <sergey@xxxxxxxxxxxxxxxx>]

2014-02-19 3:33 GMT+04:00 marco benzi <marco.benzi@xxxxxxxxxxxxxx>:

 If you could make a list I'd be more than happy to help!
>
> Marco
> -
>

Please use "reply to all" next time, the message didn't go to the list.

We have an all-encompassing wishlist at
https://docs.google.com/document/d/1wFTYGaP9RR5JwT4qQfix84-TfeFaDNX9iFviVtuCAi4/edit

But for a start we need to improve the current developer documentation:

In the dev guide we should at least link to
http://valadoc.elementaryos.org/granite/index.htm for API reference, link
to Vala tutorial <https://live.gnome.org/Vala/Tutorial> and
migration<https://wiki.gnome.org/Projects/Vala/ValaForJavaProgrammers>
guides <https://wiki.gnome.org/Projects/Vala/ValaForCSharpProgrammers>, and
to some GTK+ tutorial (GNOME developer screencasts?).

We're also missing documentation on libswitchboard and Contractor; creation
of Switchboard plugs via libpantheon is kinda sorta documented, but we've
ditched that for libswitchboard and there are no docs on that in the
website. Gotta fix that.

Finally, we have Contractor; we used to have .contract file format
documentation in the old website but it's now gone.
The Granite wrapper API is *sort of* documented in the Granite valadoc, but
the version in the website is pre-0.2.2 and doesn't include some useful
0.2.2+ symbols.
The D-bus API is documented in Contractor
specification<https://docs.google.com/document/d/1Ijsc57vYEHBZxVdM0fRgCuBX2NbdRDv1kuOj0OG75v4/edit?usp=sharing>only,
which is obscure and nobody will ever find.
I have example code for both the Vala wrapper and raw API in
https://code.launchpad.net/~elementary-pantheon/contractor/contractor-clibut
that's a very obscure location too.
And we have no UX guidelines for Contractor written, but that's a task for
the design team.

-- 
Sergey "Shnatsel" Davidoff