This page contains the details of a technical writing project accepted for Season of Docs.
Project summary
- Open source organization:
- The GNOME Foundation
- Technical writer:
- Wise4rmGod
- Project name:
- GObject tutorial consolidation
- Project length:
- Long running (5 months)
Project description
The GLib object type system documentation contains an overview of the type system and of the base object class, with topics ranging from the lifetime of an object instance, to how to install properties; from interfaces to best practices on how to write object types; and a tutorial, which covers similar topics in a more narrative way. Ideally, we should only have a tutorial covering all topics, and have specialised, in-depth documentation for the more complex aspects of the API. The base concepts section should be merged with the tutorial section by having the former section use examples and a more narrative voice from the latter.