Wiki page copied from docs



  • The "QML Viewer":http://developer.qt.nokia.com/wiki/QMLBookQMLViewer wiki page appears to be a straight copy from the "documentation":http://doc.qt.nokia.com/4.7/qmlviewer.html.

    Do we want to be duplicating the documentation in the Wiki?



  • The documentation looks much better!
    I can see a point on creating the topic on wiki in case it is a very popular topic (not very obvious to find on the documentation) but I would expect to have something more or just say: "click here for this topic on ...". I know it sounds silly but it is always about how easy is to find the information.

    There goes another idea: make the search here include the documentation! it could be one more tab on the search results.



  • I agree a topic in the wiki is good, especially if there are things to add (advice, opinions, best practices) which are not something which should be in the official docs.

    Yes search including the documentation is a good idea. Should docs results be part of the regular results or exclusively on a separate tab of the results page?



  • I'm meant to also add that although the topic is good, it should only add, not duplicate the docs. It has the same problems of duplicate code (extra maintenance to keep up-to-date).



  • Its a part of the QML Book. And I agree we don't want a copy of the documentation on the wiki. But its just an introductory part, which I found have been properly described in the documentation. And so have I also mentioned that it is under construction.

    Since its a Book on QML, I thought to add that information there. Would like to get others opinion also.

    If the content should not be duplicated on the said QML book then I can have the wiki article deleted - or updated with a refernce to the documentation



  • [quote author="Bradley" date="1292184157"]Yes search including the documentation is a good idea. Should docs results be part of the regular results or exclusively on a separate tab of the results page?[/quote]

    I have to say that I haven't been very successful searching... We get too many results and it is only bound to get much worst.

    As long as we can start the search in a single place, anything we can use to help zero in into the target the better (separate tabs, refine search, search thread, forums, tags, ...).



  • [quote author="QtK" date="1292184536"]If the content should not be duplicated on the said QML book then I can have the wiki article deleted - or updated with a refernce to the documentation[/quote]

    Updated to a reference seems sufficient to me.



  • [quote author="QtK" date="1292184536"]Its a part of the QML Book. And I agree we don't want a copy of the documentation on the wiki. But its just an introductory part, which I found have been properly described in the documentation. And so have I also mentioned that it is under construction.

    Since its a Book on QML, I thought to add that information there. Would like to get others opinion also.

    If the content should not be duplicated on the said QML book then I can have the wiki article deleted - or updated with a refernce to the documentation[/quote]

    We are just starting... I don't think we have already TOO much information. I would just make sure to add the link to the documentation. In time someone will have more to say about the topic and we will only be be able to do that in one place: the wiki page.



  • This thread reminded me of the suggestion (originally that I thought was too much) of updating the page with the latest posts when you click preview. Twice someone said the same thing I was going to say while I was typing. :(



  • [quote author="fcrochik" date="1292184892"]This thread reminded me of the suggestion (originally that I thought was too much) of updating the page with the latest posts when you click preview. Twice someone said the same thing I was going to say while I was typing. :([/quote]

    Yes, by the time I finished typing the posts were updated.



  • [quote author="Bradley" date="1292183690"]
    Do we want to be duplicating the documentation in the Wiki?[/quote]

    Certainly not. Alexandra told that when december ends, a Wiki cleanup will be needed. I've started a page about that: "Wiki cleanup":http://developer.qt.nokia.com/wiki/Wiki_cleanup

    Probably some more pages are redundant, like snippets that are already on the forum.



  • For the time being have updated it to point to the documentation.


Log in to reply
 

Looks like your connection to Qt Forum was lost, please wait while we try to reconnect.