Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Create more tutorials and guide to use Applet/Theme/Desklet/Extensions #1835

Closed
fcole90 opened this Issue Apr 2, 2013 · 8 comments

Comments

Projects
None yet
7 participants

fcole90 commented Apr 2, 2013

I think that a bottleneck of Cinnamon is the lack of plugin. The more it's easy to produce plugin the more is the people involved and there will be more plugins and more user using Cinnamon. At the moment just a little wiki and a handful of tutorial exists.. I think this is totally insufficient for newbie who just want to make simple apps..

I think what extension/applet developers really need is some API documentation. I have searched and searched, and I can't even find out what all of the options available to me are. What's in Main? What about Main.layoutManager? I have no clue. I only found those through digging through source code... totally a waste of time when all I really need is some decent comprehensive API docs. If anybody knows where they are, please let me know... if not, I think we really should make a website for them, not just a wiki.

fcole90 commented Jun 22, 2013

I think that this is a really needed task. Gnome itself has a lack of
documentation.
Some useful links:
https://developer.gnome.org/gnome-devel-demos/unstable/index.html.en
http://www.roojs.com/seed/gir-1.2-gtk-3.0/gjs/index.html
http://mathematicalcoffee.blogspot.fr/2012/09/gnome-shell-javascript-source.html
https://developer.gnome.org/glib/stable/

2013/6/22 Trevor Bortins notifications@github.com

I think what extension/applet developers really need is some API
documentation. I have searched and searched, and I can't even find out what
all of the options available to me are. What's in Main? What about
Main.layoutManager? I have no clue. I only found those through digging
through source code... totally a waste of time when all I really need is
some decent comprehensive API docs. If anybody knows where they are,
please let me know... if not, I think we really should make a website for
them, not just a wiki.


Reply to this email directly or view it on GitHubhttps://github.com/linuxmint/Cinnamon/issues/1835#issuecomment-19844663
.

Cordiali saluti,
Fabio Colella

Contributor

derAndreas commented Jul 1, 2013

+1
A year ago I started a project that addressed this issue ( https://github.com/derAndreas/pyGtk3Docs ).
But at that point of time I really had no idea what I need and what I was doing.

Last month I updated LM and again I had the feeling I need to contribute to this great distro, started digging in the sources, commented on some issues on github and felt like I can help with some pull requests.
Today I'm stuck at the same point than the last time: documentation

I looked at the official Gnome Documentation project and was so confused with their system (mallard/yelp)...

It's not only the docs of the Python/JS bindings to GI, it's also the overall workflow within cinnamon that confuses me. But I'm not commenting just to say "yeah, that is the problem".

Are there any developers out there facing this issue and want to fix this?

There should be a general discussion for a strategy to get started:

  • where will the docs be stored (I'm not a fan of any kind of wiki for this task), github -> Readthedocs?
  • does it have the chance to be supported by cinnamon project
    • like official cinnamon-dev-docs repo or something
    • not again the n-th abandoned private project, there are lots of them
  • what needs dev documentation?
    • GTK/Clutter/ST/...?
    • only JS bindings for applet developers or also python bindings to get more knowledge about cinnamon itself?
  • format (XML? not really, Markdown, reStructedText, plain text, static html...)
  • pure API Docs from GIR files or...
  • API Docs from GIR but every class/enum/bitfield/method/property should be editable/extendable
    • maybe generate a file structure of markdown files for each class/method/property and they can be extended through github with pull requests
  • beside the API docs there should be an example/tutorial for important and most used elements (like http://python-gtk-3-tutorial.readthedocs.org/en/latest/index.html )
  • many more questions...

Any kind of feedback is appreciated

fcole90 commented Jul 1, 2013

I feel thet the way that you're rpoposing is a good one ;)

2013/7/1 Andreas notifications@github.com

+1
A year ago I started a project that addressed this issue (
https://github.com/derAndreas/pyGtk3Docs ).
But at that point of time I really had no idea what I need and what I was
doing.

Last month I updated LM and again I had the feeling I need to contribute
to this great distro, started digging in the sources, commented on some
issues on github and felt like I can help with some pull requests.
Today I'm stuck at the same point than the last time: documentation

I looked at the official Gnome Documentation project and was so confused
with their system (mallard/yelp)...

It's not only the docs of the Python/JS bindings to GI, it's also the
overall workflow within cinnamon that confuses me. But I'm not commenting
just to say "yeah, that is the problem".

Are there any developers out there facing this issue and want to fix this?

There should be a general discussion for a strategy to get started:

  • where will the docs be stored (I'm not a fan of any kind of wiki for
    this task), github -> Readthedocs?
  • does it have the chance to be supported by cinnamon project
    • like official cinnamon-dev-docs repo or something
    • not again the n-th abandoned private project, there are lots of
      them
      • what needs dev documentation?
    • GTK/Clutter/ST/...?
    • only JS bindings for applet developers or also python bindings to
      get more knowledge about cinnamon itself?
      • format (XML? not really, Markdown, reStructedText, plain text,
        static html...)
  • pure API Docs from GIR files or...
  • API Docs from GIR but every class/enum/bitfield/method/property
    should be editable/extendable
  • many more questions...

Any kind of feedback is appreciated


Reply to this email directly or view it on GitHubhttps://github.com/linuxmint/Cinnamon/issues/1835#issuecomment-20263325
.

Cordiali saluti,
Fabio Colella

clerik commented Oct 23, 2014

It has been more than 1 year since the last comment. Any news if someone is doing something for the documentation problem of cinnamon, it's components and it's interfaces?

Member

collinss commented Oct 23, 2014

@clerik I started something here. I didn't get very far yet, though. I've been busy with life...

Contributor

dalcde commented May 2, 2015

@dalcde dalcde closed this May 2, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment