chore: add preview link for docs changes

[mvares]

Summary

This PR provides a preview link for pull requests that change the docs. That offers several benefits as:

• A draft view of the documentation changes included in the PR
• An automatically deployed version using GitHub Pages

Breaking Changes

This actions needs at least:

permissions: 
   pull-requests: write 

• Closes Add preview link for PRs that change docs (using vitepress) #2455

[mvares]

Before merging the PR, someone must grant some permissions to the repository related to Github Pages .

[arboleya]

We should also post the preview link as a comment on the PR.

Here's one example of how coverage report does it:

• fuels-ts/.github/workflows/test.yaml

  Lines 154 to 162 in e2259ed

  	- name: Report Coverage
  	uses: thollander/actions-comment-pull-request@v2
  	if: ${{ steps.findPr.outputs.number }}
  	with:
  	filePath: coverage/report/coverage-diff.txt
  	pr_number: ${{ (steps.findPr.outputs.number) }}
  	comment_tag: diff
  	mode: recreate
  	create_if_not_exists: true

[petertonysmith94]

Will this override our existing GitHub pages deployment?
https://fuellabs.github.io/fuels-ts/

[danielbate]

Great work, couple comments

[mvares]

Will this override our existing GitHub pages deployment? https://fuellabs.github.io/fuels-ts/

Probably yes, but we can see some way to create pages based on PR number or contributor name. (It's something we can analyze)

Get a look at this.

[petertonysmith94]

@petertonysmith94
Will this override our existing GitHub pages deployment? https://fuellabs.github.io/fuels-ts/

@mvares
Probably yes, but we can see some way to create pages based on PR number or contributor name. (It's something we can analyze)

Get a look at this.

It looks like currently GH pages doesn't support preview deployment and from the discussion, it doesn't look remotely close.

I have hesitations about deploying to our primary GH page, and potentially deploying to Vercel is a better approach. What are other peoples thoughts?

cc: @FuelLabs/sdk-ts

[mvares]

It looks like currently GH pages doesn't support preview deployment and from the discussion, it doesn't look remotely close.

I have hesitations about deploying to our primary GH page, and potentially deploying to Vercel is a better approach. What are other peoples thoughts?

cc: @FuelLabs/sdk-ts

I agree with you. Maybe it may be interesting to try something with Vercel (By the way, vercel already has a pre-deployment feature)

[Torres-ssf]

It looks like currently GH pages doesn't support preview deployment and from the discussion, it doesn't look remotely close.

I have hesitations about deploying to our primary GH page, and potentially deploying to Vercel is a better approach. What are other peoples thoughts?

cc: @FuelLabs/sdk-ts

@petertonysmith94 Agreed. We should use a different strategy here. Vercel seems to be a good suggestion.

[mvares]

@petertonysmith94 Agreed. We should use a different strategy here. Vercel seems to be a good suggestion.

@Torres-ssf, considering that we are likely already planning a different strategy here, I think this PR is now beyond their scope. Should this PR be closed?

[petertonysmith94]

@mvares I've converted it to a draft for the time being.

We can close once we know it's not needed.
Pretty sure this won't be needed so closing - I've added a comment summarising this in the issue.