workbenchdev / workbenchdev/Biblioteca

Documentation for bindings

Open
#48 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
69
Forks
11
PR merge metrics
No merged PRs in 30d

Description

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:

  • #27 - would be required for properly displaying the content, especially if loaded from online sources
  • #47 - such an API/URI schema could also support direcly loading the binding specific pages

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing related issues #27 and #47, then compare the example links for Gtk-4.0's GtkSwitch.set_active across Vala, GJS, PyGObject, and gtk-rs. Done would provide binding-specific links from Biblioteca's pages, with optional offline documentation considered only where licensing permits.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python, rust
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.