Devhelp Roadmap
This page contains the plans for major code changes we hope to get done in the future.
For a detailed history see the Devhelp NEWS file.
Tasks
State |
Markup |
todo |
<: #ff8080> todo |
in progress |
<: #ffc849> [[GnomeBug:xxxxx|in progress]] |
done |
<: #80ff80> [[GnomeBug:xxxxx|done]] |
Please add your plans here.
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 |
|
Make DhBookManager a singleton |
done |
|
3.26 |
|
Use GIO |
done |
Still all synchronous |
3.26-3.28 |
|
Fix problems in the Devhelp library API |
done |
But do not break API used by Anjuta or Builder |
3.26-3.28 |
|
Deprecate Devhelp index file format version 1 |
done |
Print a warning when loading such index files |
3.28 |
|
Write first unit tests |
done |
|
3.28 |
|
Write first page of user documentation, in Mallard |
done |
|
3.28 |
|
Do not use GCompletion (deprecated) |
Implement DhCompletion with an API better suited for Devhelp |
3.28 |
||
Flatpak: see books installed on the host (usually provided by traditional Linux distro packages) |
Not an ideal solution with Flatpak (because not fully sandboxed), interim solution |
3.28 |
||
Switch build system from Autotools to Meson |
done |
|
3.30 |
|
Update the license from GPLv2+ to GPLv3+ |
done |
|
3.30 |
|
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 |
|
Profile infrastructure in the library |
done |
To have a generic profile and a GNOME profile in the future |
3.30 |
|
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 |
|
Decouple book selection from DhBook |
done |
See commit 6493c0c554, remove DhBook "enabled" property, introduce DhBookList base class, DhBookListSimple and DhBookListBuilder |
3.30 |
|
Allow custom search paths to load DhBooks |
done |
See commit 6493c0c554, add DhBookListDirectory, remove DhBookManager implementation |
3.30 |
|
Move almost all the code in the library, to have a high-level API |
in progress |
|
3.30 |
|
Create separate libdevhelp git repository |
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 |
|
Future |
|
|
Download the latest stable/unstable GNOME API references |
Only for the GNOME profile |
Future |
|
|
Implement a start page specific for GTK+/GNOME |
Only for the GNOME profile |
Future |
|