search

ably / ably-asset-tracking-common

Common resources used by the Ably Asset Tracking SDKs.
Apache License 2.0
3 stars 3 forks source link

Improve documentation of relationships between operations #76

Closed lawrence-forooghian closed 1 year ago

lawrence-forooghian commented 1 year ago

This adds a bunch of improvements to the documentation introduced in https://github.com/ably/ably-asset-tracking-common/pull/74. See commit messages for more details.

As an example, here's the subscriber diagram before:

subscriber-before

and after:

diagram

And here’s the publisher enhanced location update diagram before:

publisher-location-update-before

and after:

publisher-location-update-after

lawrence-forooghian commented 1 year ago

I'm currently working on changes to the subscriber diagram. Do you have an idea about the approach to keeping those diagrams up to date? 🤔

No, good question! I didn't think about creating a process for updating them, because I mainly created the diagrams to help build my own understanding of the current behaviour, and wasn't sure if anybody else would care about them or want to maintain them. The documentation does say that they describe a fixed commit of the codebase, so hopefully people won't automatically assume they're up to date.

Do you think it would be worth us making sure we keep these diagrams up to date?

lawrence-forooghian commented 1 year ago

I'm currently working on changes to the subscriber diagram.

🎉 awesome!