Improvement of GTK Documentation
Improvement of GTK Documentation
The GTK documentation has some gaps that can make it difficult to understand. In my opinion, the GNOME community could benefit from a thorough redesign of the e-learning platform. What are my suggestions for improvements? Here are a few points to consider:
- Concise descriptions of functions and classes:
- Lack of clear context for new users.
- I suggest expanding the descriptions of functions and classes by adding elements that facilitate understanding, such as contextual descriptions and practical examples.
- Unclear mechanisms, such as hierarchy:
- The hierarchy is present, but its benefits are not clearly presented.
- I suggest a detailed explanation of the hierarchy, showing how to take advantage of it and what advantages it brings. It is also possible to add illustrations in the form of diagrams.
- Lack of exhaustive descriptions:
- We need comprehensive descriptions, including the name, detailed description, practical examples of use with code, as well as screenshots showing the operation.
- I suggest providing full descriptions for each function or class.
- The documentation resembles a monolith:
- There is a lack of elements that facilitate navigation, such as lists, tables, schedules.
- The only interactive element is a very long drop-down list, which also does not contain a description or example under almost any declaration.
On technical matters:
- Lack of text highlighting capability:
- The lack of this feature makes it difficult to use the documentation.
- Suggestion: Add a text highlighting feature in the documentation and consider providing alternative descriptions for visual elements.