workbenchdev / workbenchdev/Biblioteca

Support other docsets

Open
#28 1 comment 3 reactions 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

We currently support gi-docgen docs, we should support other formats.

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 reading the existing gi-docgen support in Biblioteca and compare the listed DevDocs and Dash docset formats. Decide which format is in scope and define completion as successfully viewing that format alongside gi-docgen; the issue does not name files or tests to run.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
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.