INF-899 - Update API documentation link #956
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
odcheung
commented
May 21, 2025
odcheung
commented
- Point API page to https://api.orca.so/docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the public API documentation link to point to the new API site.
- Switched the DocCard import to use double quotes
- Updated the DocCard link and description to reference https://api.orca.so/docs
docs/whirlpool/docs/04-API.mdx
Outdated
| type: "link", | ||
| href: "https://api.orca.so/docs", | ||
| label: "Visit the API reference docs on api.orca.so/docs", | ||
| description: "api.orca.so/docs", |
There was a problem hiding this comment.
Consider including the full URL (with https://) in the description for clarity and consistency with other links.
Suggested change
| description: "api.orca.so/docs", | |
| description: "https://api.orca.so/docs", |
yugure-orca
approved these changes
May 22, 2025
Collaborator
yugure-orca
left a comment
yugure-orca
left a comment
There was a problem hiding this comment.
Content: LGTM.
Changeset:
How about adding "patch" bump on @orca-so/whirlpools-docs ?
Then, "Publish" action will update docs branch.
whirlpools/scripts/deploy-docs
Line 4 in 6c0190c
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.