chore: isolate API docs #3237
chore: isolate API docs #3237
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
Finally 🙏🏼 |
…/chore/isolate-api-docs
|
@FuelLabs/sdk-ts leaving this as draft until we have a new vercel project as we deleted the last one. But the code is ready. |
CodSpeed Performance ReportMerging #3237 will not alter performanceComparing Summary
|
|
@Dhaiwat10 is going to take over this in my abcsense. I've isolated the API docs, but now we need a new project in vercel and to enable the CLI element. We should not do that until we have unfrozen |
|
Need to get these two PRs merged in order for CI to pass: |
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.
|
Update Vercel to ignore this deployment (temporarily) |
Dhaiwat10
requested review from
digorithm,
arboleya,
Torres-ssf,
Dhaiwat10,
nedsalk,
petertonysmith94 and
maschad
as code owners
There was a problem hiding this comment.
Potentially, instead of Closing the issue, we could make it related to it, then in our subsequent PR for full integration, can we close it?
- I think we should leave the changes to the
docsURLs till the subsequent PR. - We may want to add to the package path in
scripts/lint-md-links.ts.
The generated files fromapps/docs-api/src/api/mediaare currently failing the linting step.
| "../../packages/abi-coder", | ||
| "../../packages/abi-typegen", | ||
| "../../packages/address", | ||
| "../../packages/interfaces", | ||
| "../../packages/predicate", | ||
| "../../packages/account", | ||
| "../../packages/program", | ||
| "../../packages/contract", | ||
| "../../packages/script", | ||
| "../../packages/utils", | ||
| "../../packages/crypto", | ||
| "../../packages/errors", | ||
| "../../packages/hasher", | ||
| "../../packages/math", | ||
| "../../packages/transactions" |
There was a problem hiding this comment.
Currently, we only use the following packages (in: apps/docs/typedoc.json)
@fuel-ts/address@fuel-ts/interfaces@fuel-ts/predicate@fuel-ts/account@fuel-ts/program@fuel-ts/contract@fuel-ts/script@fuel-ts/utils
Do we want to add all our packages to the api-docs?
There was a problem hiding this comment.
I think this was intentional from Dan, but I am not aware of his motivation behind it
There was a problem hiding this comment.
@danielbate what was the motivation behind this?
A counter argument to this could be that if we swap out the URLs now, we can enable a smoother transition by testing thew new API docs in production and see if we face any issues. 👀 Rather than rolling out the whole thing at once without having had it tested by users in prod at all |
|
Coverage Report:
Changed Files:
|
ApiDocsoutside of the documentation. #3058Summary
Moves the API docs to fuels-ts-docs-api.vercel.app with preview URLs. Also exposed more packages with typedoc.
We have still kept the old API docs in place to facilitate a smoother transition for the docs hub.
Checklist