electric-sql / electric-sql/phoenix_sync

Document decision to not send cache headers by default in development

Offen
#55 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Elixir
Sterne
290
Forks
17
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

I noticed when using Phoenix.Sync locally that the browser wasn't caching requests as I hoped. After digging into the code I discovered that I need to configure `send_cache_headers?: true`. This worked nicely, but it would be helpful to document this (along with trade-offs and why I might not want to do this).

https://github.com/electric-sql/phoenix_sync/blob/405710ec71807563d080b4994c2284fe40f5315c/lib/phoenix/sync/electric.ex#L386-L394

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Lies lib/phoenix/sync/electric.ex ungefähr in den Zeilen 386–394, um die Einstellung send_cache_headers? und ihren Entwicklungsstandardwert zu verstehen. Füge Dokumentation hinzu, die erklärt, wie sie aktiviert wird, warum sie standardmäßig deaktiviert ist und welche Kompromisse eine Änderung mit sich bringt; als abgeschlossen gilt die Aufgabe, wenn ein Phoenix.Sync-Benutzer eine fundierte Konfigurationsentscheidung treffen kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
elixir
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.