Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

perf(syntax-lookup): optimize catalog search and detail routes

Aperta
  • Qualcosa non va?
#1,376 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
cypress, react
Ambito
documentation, frontend, performance, testing

Direzione di ricerca

Start with the /syntax-lookup and representative detail routes, using the production-artifact baseline from #1371 after the homepage stack lands on master. Profile catalog and detail assets, loader data, DOM/media counts, and query costs separately, then run the named ReScript compilation, production build, focused Vitest/Cypress coverage, and #1371 route report. Done means the listed navigation, highlighting, media, payload, and console-error acceptance criteria pass without visual snapshot updates.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement react syntax lookup

Context

The syntax lookup is both a large catalog search surface and a collection of MDX detail pages under the docs layout. Its catalog loader serializes the complete item set, builds a local Fuse index, and can render many tags; detail routes instead render compiled MDX. Optimize these two shapes together only where they share real behavior, while keeping their individual profiles visible.

The homepage work already moved syntax grammar registration to the content boundary (#1365). Retain that boundary; this ticket concerns catalog data, interactive rendering, and detail-page payloads.

Representative profiles

  • /syntax-lookup
  • A typical detail route such as /syntax-lookup/decorator_as
  • A detail route reached after a catalog query

Use the production-artifact baseline from #1371 after the homepage stack lands on master.

Suggested PR stack

  • Add catalog and detail profiles plus browser coverage for direct loads, query changes, category filtering, result-to-detail navigation, back/forward behavior, code-copy/highlighting, and docs sidebar/TOC navigation.
  • Measure catalog loader serialization, local index construction, unfiltered DOM size, and query-response work independently. Make index creation and filtering stable across renders, and defer or partition expensive client work only if the initial catalog remains useful and accessible.
  • Profile the detail loader/MDX payload and prerender static code presentation where it removes client work without compromising anchors, code tabs, copy controls, or content-boundary highlighting.
  • Audit catalog/detail media for intrinsic dimensions and priority; use responsive sources only for actual large raster placements.
  • Split optional syntax-lookup interaction code at activation boundaries and apply existing React Compiler annotations only to stable leaf components with artifact and browser coverage.

Acceptance criteria

  • Catalog and detail pages report separate, reproducible initial assets, loader-data sizes, DOM/media counts, and post-query costs; every stack layer records its delta against the immediate target.
  • Querying, category filters, result ordering, direct detail URLs, client navigation, back/forward, docs navigation, syntax highlighting, and code interaction work without hydration or console errors.
  • Initial routes do not regain homepage, playground/compiler, or eager DocSearch implementation payloads; DocSearch remains activation-loaded.
  • Every rendered image/video has numeric intrinsic dimensions and below-fold media is not needlessly preloaded.
  • ReScript compilation, production build, focused Vitest/Cypress coverage, and the #1371 route report pass. Do not update visual snapshots without approval.

Relates to #1354 and depends on #1371 for the common measurement contract.

Lingua principale
MDX
Stelle
1.9k
Fork
261
Merge medio
3g 13h
PR unite (30g)
37

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di rescript-lang/rescript-lang.org

Tutte le issue di rescript-lang/rescript-lang.org

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.