Any plans to revise or add to documentation?

Asked by Raymond

Just curious if there are any plans to improve the documentation on the official website.
More examples would be a huge help for the majority of the methods, as would a more extensive description.

Question information

Language:
English Edit question
Status:
Answered
For:
SikuliX Edit question
Assignee:
No assignee Edit question
Last query:
Last reply:
Revision history for this message
RaiMan (raimund-hocke) said :
#1

--- extensive description
What is missing? The central document is "The Complete Guide to Sikuli".

--- examples
I tried to contribute and contributed some examples. But it is a big effort, to put them in a state, that everybody (especially beginners not knowing anything about Python) can learn something from them. It even gets worth, if you try to set up more complex examples, that go beyond just having a series of find()'s and click()'s (which is well supported by just using the Sikuli IDE).
Finally I decided, to concentrate on the guide (which in fact should have some more usage examples ;-) and this Q&A area.

So you are welcome, to send examples, that shows some new aspects of Sikuli usage, to the mail address in the blog area.

--- One more thing
Look at the numbers:
For the current version there are about 30.000 downloads until today. I guess, that during the same period less than 50 people have ever used this Q&A to ask something. So you might think, that most people are getting what they need ;-)

But again: concrete hints to improve the docs and good examples are always welcome.

Revision history for this message
daluu (cuuld) said :
#2

I might have overlooked things, but is this prominently linked on the Sikuli read the docs site or the Sikuli site when one browses over the various pages of the site?

http://doc.sikuli.org/javadoc/

I was trying to find the JavaDocs for the Java API and never found it easily until today. By finding the link to old JavaDoc that returned 404 page with link to the current location.

More advanced developers would appreciate finding the JavaDocs more easily.

Revision history for this message
RaiMan (raimund-hocke) said :
#3

@daluu (just copied from the comment to your other comment ;-)

- the current official homepage for SikuliX is http://sikulix.com, this is where all the relevant links are documented (the most valuable in a shortcut at the top)

- I do not want (or partly cannot do that) to switch off old content, since many people around the world are still working with the old stuff
.
- the current docs are hosted at readthedocs (http://sikulix-2014.readthedocs.org/en/latest/), that has a little help menu at bottom right, that allows to download the stuff as PDF, HTML and ePub. Since in the future I want to stick with this free service, we have to live, with what they offer. In the docs you have a link to the current javadocs in
(http://sikulix-2014.readthedocs.org/en/latest/faq/030-java-dev.html#other-valuable-information)

- since currently there is only the nightly build (http://nightly.sikuli.de) offer until final release, on this page you also have the link to the javadocs

- the relevant tab on the homepage is QuickStart

- if you test your .chm conversion script successfullly, I would love to integrate it into my automated build and upload workflow.

Can you help with this problem?

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

To post a message you must log in.