search

ably / specification

The Ably features spec for client library SDKs.
Apache License 2.0
0 stars 4 forks source link

Fix or replace links to `ably/docs` content that was outside `content/client-lib-development-guide` #95

Open QuintinWillison opened 2 years ago

QuintinWillison commented 2 years ago

As pointed out by @lawrence-forooghian in https://github.com/ably/specification/issues/1#issuecomment-1237119315:

Screenshot 2022-10-04 at 15 41 58

The link resolves relatively and directs visitors to non-existent location at sdk.ably.com:

https://sdk.ably.com/api/rest-api#update-device-registration

When it should be to:

https://docs.ably.com/api/rest-api/#update-device-registration

We could fix this in the textile documents in this new home, or we could do some processing on the textile to replace a subset of relative URLs with absolute URLs. The latter approach there has the advantage that it keeps our textile document commit history cleaner, however at the loss of 'correctness' and an increase in 'speciality' of our processing. 🤔

lawrence-forooghian commented 2 years ago

I think that if we keep it within a single well-explained commit, a one-time edit wouldn't be much of a problem.

sync-by-unito[bot] commented 2 years ago

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-2837