Bug 244887

Summary:

[GTK] Documentation should have a tutorial on how to write a minimal browser

Product:

WebKit

Reporter:

Adrian Perez <aperez>

Component:

WebKit Misc.

Assignee:

lisiwei

Status:

ASSIGNED ---

Severity:

Normal

CC:

lisiwei

Priority:

Version:

WebKit Nightly Build

Hardware:

Unspecified

OS:

Unspecified

Attachments:

Description	Flags
Sample small minibrowsers	none

Description Adrian Perez 2022-09-07 06:36:14 PDT

Now that we use gi-docgen (bug #226662) it should be quite easy to
add Markdown files that will be included as part of the generated
documentation, as part of a section titled “Additional Documentation”.
Those Markdown files could be in Source/WebKit/gtk/docs/, for example,
and then they need to be referenced from the [extra] section of the
TOML file with the gi-docgen configuration:

  https://gnome.pages.gitlab.gnome.org/gi-docgen/project-configuration.html#the-extra-section

For example, the GTK documentation has a “Getting Started with GTK”
document:

 - Source: https://gitlab.gnome.org/GNOME/gtk/-/blob/main/docs/reference/gtk/getting_started.md
 - Result: https://docs.gtk.org/gtk4/getting_started.html

It would be great to have something similar which could explain how
to use WebKitGTK to write a simple browser.

Comment 1 Adrian Perez 2022-09-07 06:37:48 PDT

Created attachment 462182 [details]
Sample small minibrowsers

The tarball includes a very basic single window browser with only
a webview, and a multi-window one where each window has an URL entry
widget with a couple of buttons and load progress reporting.

Comment 2 lisiwei 2022-09-19 08:51:04 PDT

Pull request: https://github.com/WebKit/WebKit/pull/4485