workbenchdev / Biblioteca

Documentation viewer for GNOME
https://apps.gnome.org/Biblioteca/
GNU General Public License v3.0
59 stars 9 forks source link

Documentation for bindings #48

Open theCapypara opened 1 year ago

theCapypara commented 1 year ago

It would be great if Biblioteca would provide binding specific documentation for at least Vala, GJS, PyGObject and gtk-rs. In the simplest form it could do that by having links from all pages to the respective counterpart in these docs.

Biblioteca could also bundle offline versions of these if licensing allows.

Example for where Gtk-4.0's "GtkSwitch.set_active" would link to:

Related issues:

sonnyp commented 1 year ago

Even more related https://github.com/workbenchdev/Biblioteca/issues/28 devdocs would be a good start - we'd get plenty of docs for free + GJS

Otherwise I think we can show those in webviews (we already have the bookmarks), maybe even crawl them and make an offline version easily. But I wouldn't be in favor of building search, indexing, ... for each individual format.

I think our time would be better spent on either

  1. Make devdocs or dashdoc for these
  2. Share tooling between docs