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

Combine Errors and ErrorCodes documentation pages #2161

Closed
petertonysmith94 opened this issue Apr 25, 2024 · 9 comments · Fixed by #2198
Closed

Combine Errors and ErrorCodes documentation pages #2161

petertonysmith94 opened this issue Apr 25, 2024 · 9 comments · Fixed by #2198
Assignees
Labels
docs Requests pertinent to documentation
Milestone

Comments

@petertonysmith94
Copy link
Contributor

petertonysmith94 commented Apr 25, 2024

After the removal of Debugging Revert Errors page, and there is only a single page under errors. It'd be worth combining Errors and ErrorCodes pages.

image

Originally posted by @petertonysmith94 in #2050 (comment)

@petertonysmith94
Copy link
Contributor Author

This should have been a quick fix, however, after numerous attempted to get a single page in the config and numerous CI failure, I believe this is blocked by FuelLabs/github-actions#30.

We should look at refactoring the related vp-docs.js script to better handle our configuration file.

Setting as blocked for now.

@arboleya
Copy link
Member

arboleya commented May 1, 2024

I vaguely remember some gotchas we had with this, maybe some missing or unexpected trailing slashes?

@Dhaiwat10 I think it was one of your PRs. Ideas?

@Dhaiwat10
Copy link
Member

@arboleya unfortunately I don't seem to be remember any details. 🤔

@petertonysmith94
Copy link
Contributor Author

I tried all the gotchas I had written down. I even pulled the script and ran locally all fine. Once in the CI, the behaviour changed.

We spend quite a lot of time with this one,so I think its worth investigating a long term solution IMO.

@arboleya arboleya added the p2 label Jun 9, 2024
@arboleya arboleya added this to the Mainnet milestone Jun 9, 2024
@petertonysmith94 petertonysmith94 removed their assignment Jun 18, 2024
@petertonysmith94
Copy link
Contributor Author

Unassigned for now as it's low priority issue which could become a time sink

@arboleya
Copy link
Member

arboleya commented Jun 18, 2024

@petertonysmith94 Why the blocked label?

@petertonysmith94
Copy link
Contributor Author

#2161 (comment)

Blocked dependant on changes to the vp-docs script to allow for this behaviour, semi related to FuelLabs/github-actions#30.

@petertonysmith94
Copy link
Contributor Author

https://github.com/FuelLabs/fuels-ts/pull/2624/files#diff-48d163c9a33d438ae5ffe114ba037546d91027416af1fbd2f9e780c15505253fR73-R78

@Torres-ssf has shown me the solution lol

@arboleya
Copy link
Member

Nice one!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants