workbenchdev / workbenchdev/Biblioteca
API for browing to documentation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 69
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
It would be pretty cool if Biblioteca had some sort of API that let other apps browse it's content and present it to the user.
This could be used by IDE/editor plugins / LSPs to jump to a specific documentation within Biblioteca.
A good option would maybe be some sort of URI scheme that Biblioteca can handle?
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
The issue names no files, tests, or entry points. Start by mapping Biblioteca's current documentation navigation and lookup flow, then define how an external IDE, editor plugin, or LSP would identify a specific document. Done means an agreed API or URI approach that other applications can use to browse directly to documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, desktop
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100