[SailfishDevel] Sailfish documentation small bugs/issues and an idea how to make it more "interactive"

FIlip Kłębczyk fklebczyk at gmail.com
Sat Sep 21 18:29:09 UTC 2013


While sailing :) through the documentation found few things:

=====

1. ApplicationWindow

URL:
https://sailfishos.org/sailfish-silica/qml-sailfishsilica-applicationwindow.html


in AnotherPage.qml example there is:

import com.jolla.components 1.0

should be:

import Sailfish.Silica 1.0

=====

2. BusyIndicator

URL:
https://sailfishos.org/sailfish-silica/qml-sailfishsilica-busyindicator.html

At the bottom of the page there is empty code area (<pre 
class="qml"></pre>). Should be probably deleted.

=====

3. SearchField

"Below is a list with a search field header:"
The code below would probably look better in code area (class="qml")

=====

4. Some inconsistency in examples provided in documentation. Some of 
them have:

import QtQuick 2.0
import Sailfish.Silica 1.0

Others, have only:

import Sailfish.Silica 1.0

=====


It would be good if documentation would be more opened to community 
feedback (maybe providing a repo with it?). I like the approach used in 
PostgreSQL documentation where there are two versions of documentation - 
with and without user comments (user comments may provide useful hints, 
some code examples etc.).

Regards,
Filip


More information about the Devel mailing list