After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 632059 - Move the introduction of the tutorial in the reference
Move the introduction of the tutorial in the reference
Status: RESOLVED FIXED
Product: gtk+
Classification: Platform
Component: Documentation
unspecified
Other All
: Normal normal
: ---
Assigned To: gtk-bugs
gtk-bugs
Depends on:
Blocks:
 
 
Reported: 2010-10-13 13:47 UTC by Emmanuele Bassi (:ebassi)
Modified: 2010-10-15 16:17 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
docs: Move the introduction of the tutorial in the reference (10.89 KB, patch)
2010-10-13 13:47 UTC, Emmanuele Bassi (:ebassi)
accepted-commit_now Details | Review

Description Emmanuele Bassi (:ebassi) 2010-10-13 13:47:06 UTC
The tutorial should go away, since it contains mostly outdated documentation. Some of the content, though, can be moved to the API reference:

• the introduction and "hello world" example can be added as a separate chapter to the API reference; the examples should be included using XInclude, like we do in GIO.

• the theory of box packing can be slightly edited and moved to the GtkBox long description.

• the details of box packing can be moved to GtkBox as well.

• the details of table packing can be moved to GtkTable.

• some of the examples should be XIncluded into their relative class documentation.

The patch I'm attaching addresses the first point.
Comment 1 Emmanuele Bassi (:ebassi) 2010-10-13 13:47:09 UTC
Created attachment 172267 [details] [review]
docs: Move the introduction of the tutorial in the reference

The tutorial should just go away, but some of its contents can be moved
to the API reference as chapters.
Comment 2 Matthias Clasen 2010-10-13 16:19:58 UTC
Review of attachment 172267 [details] [review]:

Great, I like it. Maybe we want to move getting started even earlier (before building and compiling).
Comment 3 Matthias Clasen 2010-10-15 16:17:16 UTC
Committed, with some modest fixes.
I also extracted some stuff from the boxes and tables sections.
Clearly, we need to grow the tutorial section over time, with more examples.