Initial documentation of entity configuration

[oandregal]

Part of #55153

What?

This PR aims to create some initial docs explaining what is an entity and what it needs in terms of configuration.

Why?

It's a crucial part of Gutenberg. Having some introductory high level documentation would help folks to navigate this part of our codebase.

How?

Adds a new section in the README.md of the core-data package.

See

Read the section "What's an entity".

[oandregal]

Pinging some folks that have worked with the core-data package recently. Note this PR doesn't aim to be comprehensive not cover all the properties, but a starting point to be iterated upon.

[youknowriad]

For me REST API is just an implementation detail and my ultimate Goal has always been to decouple from the WordPress REST API using an adapter layer, so in that sense, I'm not a big fan for tieing a definition of an entity to the backend.

I'd define an entity as a type of "model/data" or something like that that the data layer provides to the consumers. Granted that the current definition is tied to the REST API though but this is consequential to me.

[oandregal]

Pushed an update that tones down the WordPress REST API in favor of a more general approach.

[github-actions]

Flaky tests detected in ae108b4.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6433339008
📝 Reported issues:

• [Flaky Test] dims background image down by 50% with the average image color when an image is uploaded #55086 in /test/e2e/specs/editor/blocks/cover.spec.js

[aaronrobertshaw]

It's great seeing all the new documentation lately, nice work 👍

I'd define an entity as a type of "model/data" or something like that that the data layer provides to the consumers

FWIW this aligns with what I sort of expected for the entity definition.

Other than that, there were a few minor nits and typos I've left as inline suggestions. Hope that helps 🙂

[youknowriad]

👍

[tyxla]

I think these are some very useful docs 👍 Couldn't find anything beyond a minor grammar fix.

Thanks @oandregal 🚀