Project

General

Profile

Actions

Improvements #11969

open

Extend and validate widget documentation

Added by Matthias Van Ceulebroeck over 1 year ago. Updated 2 months ago.

Status:
InProgress
Priority:
Normal
Target version:
Start date:
09/21/2023
Due date:
% Done:

0%

Estimated time:

Description

The documentation that Wt provides, while already sometimes fairly big, is still lacking in certain ways.

Some documentation is out of date, and needs to be corrected. This could lead to entries on the forum with questions that could be avoided with more correct documentation.
Similar to the above case is unclear documentation, where people may be confused about how to use a specific thing, and attempting something that is not viable.

Generally the documentation should be extended as well, to include some examples of common usage. The widget gallery already contains some examples, but that doesn't cover all use-cases.
While it isn't possible to have documentation that spans all potential uses, it is a good idea to include limited examples of most common (and thus most "correct") usage.


Related issues 1 (0 open1 closed)

Related to Improvements #12862: Extend build and minimum requirements documentationClosedMatthias Van Ceulebroeck07/29/2024

Actions
Actions #1

Updated by Matthias Van Ceulebroeck about 1 year ago

  • Target version changed from 4.10.2 to 4.10.3
Actions #2

Updated by Matthias Van Ceulebroeck 5 months ago

Actions #3

Updated by Matthias Van Ceulebroeck 5 months ago

  • Target version changed from 4.10.3 to 4.11.1
Actions #4

Updated by Matthias Van Ceulebroeck 2 months ago

  • Target version changed from 4.11.1 to 4.11.2
Actions

Also available in: Atom PDF