slashmo / gsoc-swift-tracing

WIP collection of Swift libraries enabling Tracing on Swift (Server) systems.
https://summerofcode.withgoogle.com/projects/#6092707967008768
Apache License 2.0
20 stars 1 forks source link

Write complete persona-specific "how to use this" docs #130

Closed ktoso closed 4 years ago

ktoso commented 4 years ago

We should stick to our "division" of "who" and "how" uses this API and fully document it. Only once fully documented and proven in one or two integrations can we slowly claim to stabilize the API.

Complete documentation has a magical power of uncovering edge cases etc, and of course matters for adoption.

Our "personas" are:

slashmo commented 4 years ago

Forgot to close this via #139. @ktoso feel free to re-open if not everything has been covered yet.

ktoso commented 4 years ago

Sounds good thanks :) so far we're okey, will revisit in some time