workbenchdev / workbenchdev/Biblioteca

Provide option to filter docs

Open
#57 4 comments 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

From discussion https://github.com/workbenchdev/Biblioteca/pull/52#discussion_r1398862715, most people might not need most of the docs that are shipped by default, therefore it makes sense to provide an option to filter docs according to user preference. It might also make up for faster load times. We can have something similar to DevHelp

image

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 discussion linked from PR #52 and then trace the existing documentation loading and display entry points. Define how user preferences select documentation and how completion will be verified, including whether filtering improves load times as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.