processing / processing/p5.js-website
Website search should be improved
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 96
- Forks
- 322
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 8
Description
Increasing Access
Currently, the keyword search on the website often does not help users find what they look for. This is evident in usability testing, and in issue reports. To make the information on the site more accessible, search should be improved.
Most appropriate sub-area of p5.js?
Other (specify if possible)
Feature request details
- Here is the current search script: https://github.com/processing/p5.js-website/blob/main/src/scripts/builders/search.ts
- There is also a filter on reference: https://github.com/processing/p5.js-website/blob/main/src/components/ReferenceDirectoryWithFilter/index.tsx
- Commit introducing main portion of current search: https://github.com/processing/p5.js-website/commit/993e6c59a4eda4d5f0819e5b0a9fdd85e039fedc
- This issue is for research for what's possible technically: comments and draft PRs that demonstrate an idea are welcome from different people! But it is not yet ready for focused work. But keep in mind if you make a PR it may be closed.
Related issues
- https://github.com/processing/p5.js-website/issues/493 search through descriptions
- https://github.com/processing/p5.js-website/issues/459 search field suggestions dropdown feature
- https://github.com/processing/p5.js-website/issues/1249 searchProvider bug
Contributor guide
No contributing guide indexed for this repository
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
Start by reading src/scripts/builders/search.ts and src/components/ReferenceDirectoryWithFilter/index.tsx, then review commit 993e6c59a4eda4d5f0819e5b0a9fdd85e039fedc59 and the related search issues. Done means documenting technically viable search improvements or demonstrating an idea in comments or a draft PR, rather than delivering a focused implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend, search
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100