[Development] Towards a Qt 5 beta: Documentation

[casper.vandonderen at nokia.com]

Hi,

>
>There are other tasks that seems to be missing.
>
>- What is documentation? Are we talking only about the API docs or also
>about code examples, tutorials, demo videos?

I don't want to talk about any of the non-API documentation for now, since
that is also a mess that needs to be cleaned up. I think we should first
try to get the key features for people that already use Qt in place and
focus on content for new users later.

>- Who are the contributors working specifically in the deliverables
>described above, and who is the overall responsible? Now it feels that a
>lot of responsibilities fall between the cracks. That was ok-ish for the
>pre-alpha phase but now we need more organization.

I am working on the cross-linking, Since I have not heard concrete other
ideas I'll just implement the proposal and try to keep the current
"magical" system working at the same time.

Nobody is responsible in the end. The most responsibility I am willing to
take is delivering a QCH package of the documentation when we build an
SDK/give a documentation package to the DevNet people to publish. This
means other people/companies will also have to step in.

>- What are the deliverables for the beta release? Documentation wasn't a
>showstopper for an alpha release but certain documentation criteria need
>to be met for the beta. What are those criteria?

The deliverables are a QCH package and getting the documentation on the
DevNet.

There are no concrete criteria, but I would like to enforce that we have a
similar amount of qdoc errors in 5.0 compared to 4.8.
4.8 has around 50 qdoc errors. The monolithic 5.0 package currently has
around 8000, I cannot say anything about modular 5.0 yet.


Casper