Devhelp Roadmap

State

Markup

todo

<: #ff8080> todo

in progress

<: #ffc849> [[GnomeBug:xxxxx|in progress]]

done

<: #80ff80> [[GnomeBug:xxxxx|done]]

Task

Status

More info

Release(s)

Credits

Add GTK-Doc API reference and GObject Introspection support for the Devhelp library

done

3.24-3.26

CorentinNoël and SébastienWilmet

Make DhBookManager a singleton

done

3.26

SébastienWilmet

Use GIO

done

Still all synchronous

3.26-3.28

SébastienWilmet

Fix problems in the Devhelp library API

done

But do not break API used by Anjuta or Builder

3.26-3.28

SébastienWilmet

Deprecate Devhelp index file format version 1

done

Print a warning when loading such index files

3.28

SébastienWilmet

Write first unit tests

done

3.28

SébastienWilmet

Write first page of user documentation, in Mallard

done

3.28

SébastienWilmet

Do not use GCompletion (deprecated)

done

Implement DhCompletion with an API better suited for Devhelp

3.28

SébastienWilmet

Flatpak: see books installed on the host (usually provided by traditional Linux distro packages)

done

Not an ideal solution with Flatpak (because not fully sandboxed), interim solution

3.28

SébastienWilmet

Switch build system from Autotools to Meson

done

3.30

IñigoMartinez and SébastienWilmet

Update the license from GPLv2+ to GPLv3+

done

3.30

SébastienWilmet

Clear separation between library and app

done

Still in the same git repo, move library to its own directory, split some source files in two, correctly handle GSettings in the library, in the app use only really public libdevhelp APIs

3.30

SébastienWilmet

Profile infrastructure in the library

done

To have a generic profile and a GNOME profile in the future

3.30

SébastienWilmet

Loads of refactorings all over the place, fixing bugs along the way

mostly done

3.18-3.30

Mostly SébastienWilmet

Use the Amtk library

done

To avoid information duplication, and will permit to provide a higher-level libdevhelp API.

3.30

SébastienWilmet

Decouple book selection from DhBook

done

See commit 6493c0c554, remove DhBook "enabled" property, introduce DhBookList base class, DhBookListSimple and DhBookListBuilder

3.30

SébastienWilmet

Allow custom search paths to load DhBooks

done

See commit 6493c0c554, add DhBookListDirectory, remove DhBookManager implementation

3.30

SébastienWilmet

Move almost all the code in the library, to have a high-level API

in progress

3.30

SébastienWilmet

Create separate libdevhelp git repository

todo

To have a real library, with different major versions installable in parallel. Before porting to GTK+ 4, to not force IDEs to be ported to GTK+ 4 during the same development cycle.

Future

Asynchronous I/O

todo

Future

Download the latest stable/unstable GNOME API references

todo

Only for the GNOME profile

Future

Implement a start page specific for GTK+/GNOME

todo

Only for the GNOME profile

Future