workbenchdev / workbenchdev/Biblioteca
Use `.devhelp2` instead of `index.json`
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 69
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Currently we use index.json for indexing but that's actually made for search. We should use the .devhelp2 file for indexing.
That's what Manuals do. And it will let use support /usr/share/gtk-doc
For example gdk4-wayland doesn't have an index.json
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the code that currently reads index.json for documentation indexing and inspect how documentation sources are discovered. Verify the implementation against a gdk4-wayland documentation set and a /usr/share/gtk-doc installation; done means indexing works from .devhelp2 files even when index.json is absent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100