artefactual / atom-docs

Access to Memory (AtoM) documentation
https://www.accesstomemory.org/docs
Creative Commons Attribution Share Alike 4.0 International
17 stars 26 forks source link

Overview - core_entity_types.png is out of date #214

Closed kieranjol closed 1 year ago

kieranjol commented 1 year ago

It appears that the entity types here: https://www.accesstomemory.org/en/docs/2.7/_images/core-entity-types.png are out of date and do not align with the list of entity types in the text: https://www.accesstomemory.org/en/docs/2.7/user-manual/overview/entity-types/

fiver-watson commented 1 year ago

Hi @kieranjol , thanks again for mentioning this. I've added an updated image here:

It may take a bit for us to propagate the change to the website - I see we have some automated test issues to resolve. I also added the following comments on the PR, which I'll copy here for reference:

Note that the documentation still doesn't exactly match all the entities shown in the diagam - now, rather than showing far less, the diagram actually shows more than what is described in the Entity Types documentation, including Events, Donors, etc.

Despite this, it's a more accurate diagram; the Entity types page can be further updated later if desired but still has the key entities described; and there's not a separate docs page on events (since it's more of an internal design term than something shown to end users).

Anyway, hope this is an improvement for you. Thanks again!

kieranjol commented 1 year ago

This is great, thank you!

K