Skip to content

Commit

Permalink
[field] Remove incorrect readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rexxars committed Oct 6, 2020
1 parent f6d9ba5 commit d846781
Showing 1 changed file with 0 additions and 30 deletions.
30 changes: 0 additions & 30 deletions packages/@sanity/field/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +0,0 @@
# @sanity/diff: Tools for diffing data structures

`@sanity/diff` is a library for calculating and presenting _diffs_ of content.

## Concepts and architecture

- The main data structure is `Diff` which represents a difference between two versions. This is a
nested data structure so if it's an `ObjectDiff`, then its children will have `Diff` as well.

The `Diff` is built on top of the _unchanged_, _added_ and _removed_ primitives. This means that
it will contain both versions at the same time and it's always trivial to recreate the old/new
version (by ignoring the added/removed parts of the diff).

Note that for arrays and objects, unchanged/added/removed only have a "shallow" meaning. An
`ObjectDiff` will have a *unchanged field* if the field was present in both the old and new
version - regardless of whether there's any internal changes.

- `Diff` also supports _annotations_. These contain information about when a change was introduced
and who was responsible for it.

- To construct a `Diff` you need to represent the versions as `Input` types and use `diffInput(from,to)`
to create the diff. The primary reason for a separate `Input` type is to support passing along
annotations. In addition, this allows us to optimize based on the object equality of the inputs.

- There are multiple ways of _presenting_ a diff: Sometimes you want to only show the fields that
has changed, and other times you want to show the full new (or old!) document interspersed with the
changes.

This library does _not_ contain any UI components, but instead provides various
presentation-related helper functions.

0 comments on commit d846781

Please sign in to comment.