Update documentation for 5.3

Question

Update documentation for 5.3

kadamwhite opened this issue 5 years ago · comments

K Adam White commented 5 years ago

When 5.3 ships we should update associated documentation. This will be a running list of things we should cover.

Array & Object Metadata
_fields nesting
New media endpoint (with note it's really intended for internal use)
Performance?
Audit tickets to figure out what else is needed (report of closed tickets)
Update Changelog

K Adam White · Answer 1 · Fri Nov 08 2019 02:30:10 GMT+0800 (China Standard Time)

Fields is now documented, see #61

Timothy Jacobs · Answer 2 · Thu Nov 28 2019 08:54:25 GMT+0800 (China Standard Time)

I have a WIP for metadata in #69.

Timothy Jacobs · Answer 3 · Thu Nov 28 2019 09:29:07 GMT+0800 (China Standard Time)

I think we could document the schema caching performance improvement in controller-classes.md? I opened #70 for that.

I think the new media endpoint would get imported when we regenerate the reference? It'd be nice if we could figure out a way to add custom information to those descriptions so we could notate that it is for internal use.

Looking through the tickets, I didn't find any that I think warrant large sections. But these are the ones I think would be good to add to the changelog.

K Adam White · Answer 4 · Tue Mar 31 2020 01:48:18 GMT+0800 (China Standard Time)

Marking as to-be-resolved by #92