docs(ui): record the History & Versions diff-rendering decision#246
Open
angela-helios wants to merge 1 commit into
Open
docs(ui): record the History & Versions diff-rendering decision#246angela-helios wants to merge 1 commit into
angela-helios wants to merge 1 commit into
Conversation
Two server-side layers rendered through Askama with htmx fragment swaps: json_patch::diff (already a dependency; the inverse of the PATCH interaction) for the semantic field-level view, and similar (inline feature, added at implementation time) for the word-level textual view. Client-side diff libraries rejected: they break the no-CDN and JS-off baselines. Includes the spike output characterizing RFC 6902 array churn on a front-inserted name[] element (six-op cascade, accepted for v1), and the decisions on metadata noise filtering, version selection, where the diff is computed, and deleted-version rendering.
Contributor
|
Can you implement a prototype and we can evaluate from there. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #236. The research issue asked for "a decision recorded here (and ideally an ADR or a short section in
docs/ui-requirements.md)" — this is that record, as a standing doc indocs/(the ui-requirements doc lives on an unmerged branch, so the decision gets its own file the same waydocs/search-conformance-plan.mddoes).Contents: the adopted two-layer server-side approach (
json_patch::diffsemantic view — zero new deps, the inverse of the existing PATCH interaction — plussimilarwith word-level inline highlighting rendered through Askama, no JS runtime), the executed spike output characterizing RFC 6902 array churn on a front-insertedname[]element, and the recorded decisions on metadata-noise filtering, version selection, where the diff is computed, and deleted-version rendering. Alternatives table and full discussion stay in the issue.Implementation is tracked by the History & Versions screen work, not this issue.