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

chore: remove validation for ts api docs #485

Merged
merged 14 commits into from
Dec 6, 2024

Conversation

Dhaiwat10
Copy link
Member

This PR removes the validation in place for the TS SDK API docs since they have now been isolated in a different project on a different URL (FuelLabs/fuels-ts#3237) and they are now only referenced from the 'main' TS SDK docs.

Nazeeh21
Nazeeh21 previously approved these changes Oct 25, 2024
@petertonysmith94 petertonysmith94 marked this pull request as draft October 28, 2024 11:09
@petertonysmith94
Copy link
Contributor

petertonysmith94 commented Oct 28, 2024

We're looking to approach this migration in a phased approach, so we converted this to a draft.

danielbate
danielbate previously approved these changes Nov 25, 2024
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

It may be nice to keep the API link that opens a new window with the api-docs. I approve of these changes.

image

@Dhaiwat10
Copy link
Member Author

@petertonysmith94 not really sure how to do that. @FuelLabs/devrel any ideas? 👀

@danielbate
Copy link
Contributor

@petertonysmith94 @Dhaiwat10 I have included the link on the TS docs home page. We'd probably have to include it in the links json file but that'll probably break some kind of validation. IMO it should not block this work.

@danielbate
Copy link
Contributor

@calldelegation @rishabhkeshan please let us know when you've had a chance to check this PR

calldelegation
calldelegation previously approved these changes Dec 5, 2024
calldelegation
calldelegation previously approved these changes Dec 6, 2024
danielbate
danielbate previously approved these changes Dec 6, 2024
Copy link
Contributor

@petertonysmith94 petertonysmith94 left a comment

Choose a reason for hiding this comment

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

@Dhaiwat10 we also need to remove the following line to ensure the automated versions doesn't check out our docs branch.

@danielbate danielbate self-requested a review December 6, 2024 16:49
@calldelegation calldelegation merged commit f6d00fd into master Dec 6, 2024
9 of 14 checks passed
@calldelegation calldelegation deleted the dp/remove-ts-api-docs branch December 6, 2024 18:37
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.

6 participants