META: Remaining code cleanup for quant_search module

Created on 2 September 2022, about 2 years ago
Updated 5 March 2024, 9 months ago

Problem/Motivation

Reviewed all the quant_search code pretty carefully and see some additional things that could be addressed at some point:

  1. 📌 CodeSniffer DrupalPractice coding standards for quant_search code Closed: won't fix
  2. 🐛 Quant search entity overrides required field issue Fixed
  3. Quant search facet areas can be completely empty which isn't great UX Active
  4. All @todo items (currently 5)
  5. Better example(s) for manual filters
  6. Document how to add images
  7. Show tokens on Entity configuration tab
  8. Layout issues on search page using Olivero theme
    • Filters work but wrap
    • X for search textfield
  9. SEO/accessibility issues for search page (may be Algolia specific)
    • Headings need to be in sequential order (right now it goes from h1 to h4)
    • Form fields are supposed to have labels for a11y (we can hide if you don’t want it show)
    • Page needs a meta description
    • There is a silly bug with Lighthouse SEO score that doesn’t like anchors with just id (says links are not crawlable) so you have to use name or both id and name for it to pass that check
    • IMO the visible description doesn’t need an heading tag, just can be plain text
  10. Testing and cleanup in Entity configuration code (didn't really spend much time looking at this; related: Better support of taxonomy in quant_search Postponed
    • Layout is confusing because it looks like the Default/Article/Basic page is somehow related to Taxonomy terms because the Nodes checkbox has something under it
    • View mode doesn't seem to be working
    • Teaser makes more sense for view mode default
  11. Note sure why routes are nested under /admin/config/development/quant/ rather that /admin/config/search/quant/ or just /admin/config/quant/
  12. SearchPagesForm isn't referenced, so could be removed but check with Stu/Steve first
  13. Add note on search pages that these do not show up on Dashboard Search and vice versa?
  14. Create tests
  15. Nitpick: Inconsistent lang_code vs langcode (though maybe an Algolia thing?)

Steps to reproduce

Proposed resolution

Assess and make followup child tickets as needed.

Remaining tasks

  1. Assess each item
  2. Create followup issue if warranted
  3. Do the work :)

User interface changes

API changes

Data model changes

📌 Task
Status

Postponed

Version

1.0

Component

Code

Created by

🇺🇸United States Kristen Pol Santa Cruz, CA, USA

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024