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 link in readme #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix link in readme #3

wants to merge 1 commit into from

Conversation

vvenance
Copy link

@vvenance vvenance commented May 4, 2023

No description provided.

@vvenance vvenance requested review from paulRbr and Polo2 May 4, 2023 15:21
@@ -20,6 +20,6 @@ From an [OpenAPI](https://spec.openapis.org/oas/latest.html) or [AsyncAPI](https

Share a link to your documentation with your API consumers and help them to never miss an API change again. They will have the possibility to **track API structural changes** if they subscribe by email. Once a week, subscribers will receive a changelog digest of your documentation if your API has changed. Curious? Here is the API [documentation changelog](https://developers.bump.sh/changes) of our own API.

To make the most out of Bump, we suggest integrating our tool in your development process. We offer a [Command Line Interface](https://github.com/bump-sh/cli/blob/master/package.json) and [Continuous Integration](https://help.bump.sh/continuous-integration) examples to let you: view API diff during code review thanks to our [Github Action](https://github.com/bump-sh/github-action), Bump will automatically **comment your pull requests with changes digest**, then once merged we will **deploy your changes** directly to your documentation page.
To make the most out of Bump, we suggest integrating our tool in your development process. We offer a [Command Line Interface](https://github.com/bump-sh/cli/blob/main/package.json) and [Continuous Integration](https://help.bump.sh/continuous-integration) examples to let you: view API diff during code review thanks to our [Github Action](https://github.com/bump-sh/github-action), Bump will automatically **comment your pull requests with changes digest**, then once merged we will **deploy your changes** directly to your documentation page.
Copy link
Member

@paulRbr paulRbr May 4, 2023

Choose a reason for hiding this comment

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

What about linking to the root of the repo? I also suggest to change the help page with the new URL.

Suggested change
To make the most out of Bump, we suggest integrating our tool in your development process. We offer a [Command Line Interface](https://github.com/bump-sh/cli/blob/main/package.json) and [Continuous Integration](https://help.bump.sh/continuous-integration) examples to let you: view API diff during code review thanks to our [Github Action](https://github.com/bump-sh/github-action), Bump will automatically **comment your pull requests with changes digest**, then once merged we will **deploy your changes** directly to your documentation page.
To make the most out of Bump, we suggest integrating our tool in your development process. We offer a [Command Line Interface](https://github.com/bump-sh/cli) and [Continuous Integration](https://docs.bump.sh/help/continuous-integration) examples to let you: view API diff during code review thanks to our [Github Action](https://github.com/bump-sh/github-action), Bump will automatically **comment your pull requests with changes digest**, then once merged we will **deploy your changes** directly to your documentation page.

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.

2 participants