Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
QuintinWillison opened this issue Oct 4, 2022 · 2 comments
Labels
bug Something isn't working

Comments

@QuintinWillison
Copy link
Contributor

As pointed out by @lawrence-forooghian in #1 (comment):

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
Copy link
Collaborator

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

@QuintinWillison QuintinWillison added the bug Something isn't working label Oct 5, 2022
@sync-by-unito
Copy link

sync-by-unito bot commented Oct 17, 2022

➤ Automation for Jira commented:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Development

No branches or pull requests

2 participants