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

Add mention about Bump.sh API Explorer in relevant pages #327

Merged
merged 2 commits into from
Feb 3, 2025

Conversation

jayk-u
Copy link
Contributor

@jayk-u jayk-u commented Jan 31, 2025

I’ve chosen to announce the availability of the new API Explorer as a callout on the relevant pages, with a link to the PU and a demo doc.

I believe I’ve covered all the relevant pages, but let me know if the wording works for you!

@jayk-u jayk-u self-assigned this Jan 31, 2025
Copy link

netlify bot commented Jan 31, 2025

Deploy Preview for bump-content-hub ready!

Name Link
🔨 Latest commit 8d60e7b
🔍 Latest deploy log https://app.netlify.com/sites/bump-content-hub/deploys/67a0c0bae06f830008848a30
😎 Deploy Preview https://deploy-preview-327--bump-content-hub.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@grossyoan grossyoan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Jay!

Just a small feedback: we might want to remove the space between "try" and "!" in "Give it a try!"

Nonblocking for me.

@@ -67,6 +67,7 @@ There are many tools to help you get the most out of OpenAPI, at every step of t

### Testing

* [Bump.sh](https://bump.sh/api-documentation) 💙
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [Bump.sh](https://bump.sh/api-documentation) 💙

It's not "testing" in the same sense. Testing, in this paragraph, is about automated/technical tests

Comment on lines 27 to 28
> Bump.sh now includes its own [API Explorer](https://docs.bump.sh/product-updates/2025/01/09/api-explorer/), allowing you to test your API directly within your documentation. [Give it a try !](https://bump.sh/demo/doc/api-explorer/explorer/operation/operation-adduser)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> Bump.sh now includes its own [API Explorer](https://docs.bump.sh/product-updates/2025/01/09/api-explorer/), allowing you to test your API directly within your documentation. [Give it a try !](https://bump.sh/demo/doc/api-explorer/explorer/operation/operation-adduser)

Although this can be valuable information for our readers, I would refrain from adding it in this specific text, which focuses on Technical Writers skills rather than tooling.

@ChristopheDujarric ChristopheDujarric merged commit 79ef7f0 into main Feb 3, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants