near / Pagoda-Roadmap

Repo for testing GH project management features.
3 stars 0 forks source link

🔰 [Initiative] Component Code Searchable #135

Open TiffanyGYJ opened 10 months ago

TiffanyGYJ commented 10 months ago

Description

Component code is indexed and used as part of search algorithm

User Flow

Search component with code in index

  1. A developer is looking for a component that completes the infinite scrolling logic
  2. The developer search for "infinite scroll" using search (command palette, universal search bar, search bar in sandbox)
  3. The developer sees a list of component with same experience described in 🔰 [Initiative] Component Search Data Enrichment + Intuitive Component Display#64
  4. The developer is able to see some components that has "infinite scroll" in their code even though this keyword is not written in the metadata of components

Search code and use as reference

  1. A Developer is looking for a component that involves "ethers.js" or examples of specific APIs like Social.index or Storage.set to use as a reference
  2. The developer input these strings in the search function (command palette, universal search bar, search bar in sandbox)
  3. Developer sees a list of components that contains code with the string
  4. Developer sees the portion of the code where the string is used highlighted
  5. Developer clicks several ones and develops an understanding of how its used

The implementation of this product will be divided to 2 phases

  1. POC with basic design aiming to test the functionality and backend to iterate
  2. MVP with designs researched and tested at NEARCon

Notes

Resources

(Relevant documentation, Figma links, and other reference material)

### Related Epics
- [ ] https://github.com/near/data-platform/issues/15
- [ ] https://github.com/near/data-platform/issues/14