openedx / openedx/paragon

Implement filtering of Icons on docs site

Open
#2,341 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs raccoon-gang
Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

Currently we have two separate pages for icons: one that contains all of them and the other contains only Bootstrap's brand icons (related PR: https://github.com/openedx/paragon/pull/2324). It would probably be better to have only one page but with filtering functionality.

### AC
- [ ] Consider adding filtering to the [main icons page](https://paragon-openedx.netlify.app/foundations/icons)
    - [ ] Users should be able to switch between Bootstrap's brand icons and all icons
    - [ ] Try to implement it in such a way that would make it easy to add new categories in future

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

Open the main icons page linked in the task and compare it with the separate brand-icons page described in the issue. Define the filter categories so users can switch between all icons and Bootstrap brand icons, then verify both views and that another category could be added without redesigning the page.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.