Consistent about Ably section for all public Ably repos

mattheworiordan commented 4 years ago

We have lots of public repos, from client SDKs (https://github.com/ably/ably-js) to docs (https://github.com/ably/docs) to load testing (https://github.com/ably/ably-boomer) to demos (https://github.com/ably/whiteboard).

We should review generic about Ably messaging that exists in all public repos that gives users context, explains what Ably does, etc.

┆Issue is synchronized with this Jira Task by Unito

tbedford commented 3 years ago

@marklewin - this ties in with the work on reviewing READMEs and providing a README template. We should also look to see if we can improve README consistency, messaging etc across all repos.

ably-sync-bot commented 3 years ago

➤ Mark Lewin commented:

See https://github.com/ably/ably-common/pull/88 ( https://github.com/ably/ably-common/pull/88|smart-link )

ably-sync-bot commented 3 years ago

➤ Mark Lewin commented:

This still requires work. Will speak with Quintin Willison about adding a consistent overview to the SDK README templates and then ensure that this is replicated across all our repos.

Kieran Kilbride-Singh : do we have a one or two-line summary of the Ably offering that you would recommend for this?

ably-sync-bot commented 3 years ago

➤ Kieran Kilbride-Singh commented:

Hey Mark Lewin - here’s the one-liner we used for the Ably GitHub description:

Ably’s platform lets you build, extend, and deliver powerful digital experiences in realtime. No complex infrastructure to manage just simple yet powerful APIs.

Here’s a couple sentences if we want to add a bit more, but might be a bit marketingy:

Ably is the platform that powers synchronized digital experiences in realtime. Whether attending an event in a virtual venue, receiving realtime financial information, or monitoring live car performance data – consumers simply expect realtime digital experiences as standard. Ably provides a suite of APIs to build, extend, and deliver powerful digital experiences in realtime for more than 250 million devices across 80 countries each month. Organizations like Bloomberg, HubSpot, Verizon, and Hopin depend on Ably’s platform to offload the growing complexity of business-critical realtime data synchronization at global scale.

tbedford commented 3 years ago

Sorry for barging in, but I really like the second option - that is a very nice summary. p.s. we should have a link to the docs page too - with link text something along the lines of "See the Ably documentation for further information.". :)

ably-sync-bot commented 3 years ago

➤ Mark Lewin commented:

Thanks Kieran Kilbride-Singh and Tony Bedford !

ably-sync-bot commented 3 years ago

➤ Mark Lewin commented:

ably / docs

Consistent about Ably section for all public Ably repos #967