Is there any developer documentation available?

Asked by Martin Harvan

Hi,
I have some ideas for Docky plugins and it would be good practice for me since I am learning C# now, is there any documentation for that or can someone point me where should I look at?

Question information

Language:
English Edit question
Status:
Answered
For:
Docky Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
Jason Smith (jassmith) said :
#1

You could look at existing plugins. After we race to meet this deadline I am going back and making documentation.

Revision history for this message
The Fiddler (stapostol) said :
#2

I'm copying my comments from question 91925 which was marked as a duplicate of this:

There is no readme, no list of dependencies or anything else that would help a willing contributor get started.

What I would like to see is this:
1. a very short compilation guide, in the spirit of "install foo and bar, then run autogen.sh or open Docky-2.sln".
2. a simple overview of docky's architecture: what each project does and how it fits together with the rest.
3. a code style and best practices guide. (For example, the project is using Mono-style formatting as far as I can see, stuff like that).
4. a simple guide to writing a plugin (maybe even provide a skeletal plugin that the user can jump in and edit directly).
5. any other thing you think a new developer should be aware of (for example, licensing, copyright, how to submit a patch...)

As Robert Dyer commented, there actually *is* a compilation guide (http://do.davebsd.com/wiki/Installing_Docky). This is a good start but (a) this page, or a link to this page, should be added to the docky source repository and (b) this guide fails to mention MonoDevelop, which doesn't work out of the box right now (see https://bugs.launchpad.net/docky/+bug/492804). After fixing those issues, item #1 will be covered 100%.

Revision history for this message
The Fiddler (stapostol) said :
#3

According to https://bugs.launchpad.net/docky/+bug/492804:

"Note that compiling/installing Docky from MonoDevelop is not an officially supported method."

Is it recommended to use vi and mdb directly in order to test/debug docky? If so, maybe this should be mentioned somewhere in the docs or the installation guide.

Revision history for this message
airtonix (airtonix-gmail) said :
#4

Also : a break down of methods for c-sharp and python would be nice.

much like how jquery docs appear.

Can you help with this problem?

Provide an answer of your own, or ask Martin Harvan for more information if necessary.

To post a message you must log in.