-
Notifications
You must be signed in to change notification settings - Fork 46
Adds intro copy to all pages #3045
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
base: main
Are you sure you want to change the base?
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
I like the standaridsation approach this has taken, but I think we need to review these in conjunction with the opening sentences and paragraphs on the page as they've introduced quite a lot of duplication. |
7e29f3b to
e0a8879
Compare
4ccffa8 to
5a5356e
Compare
4a97422 to
acc6920
Compare
Hi Mark, I have had another pass at this. Only this time I have used claude to do a review of the page and give a small snippet as to what the user can expect by reading further. I have kept it consistent and used the active voice in addition to the "docs style" |
🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
acc6920 to
c346e90
Compare
GregHolmes
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not entirely sure what the answer is here, but of the intros and the first paragraph or two after I feel there's a lot of duplicate text. Again, not sure what the answer is. But feel something would need to change first. What do you think
| --- | ||
| title: Basic auth | ||
| meta_description: "Basic authentication allows you to authenticate a secure server using an Ably API key and secret." | ||
| intro: "Basic authentication enables secure server-to-server connections using your full API key for complete access to Ably services. This authentication method provides the simplest integration path for trusted backend services that handle sensitive operations." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is line 3, just a fluffier way of saying line 7 and without the link? I can't help but feel line 7 (other than the link) is needed with the intro being added. What do you think?
This PR:
Checklist