feat: implement typedoc in vitepress

[danielbate]

Following discussions in #835, this reimplements typedoc to provide API documentation to be housed by our current vitepress implementation by:

• Installing typedoc along with the modular and markdown plugins and adding to vitepress config
• Implementing typedoc config in the Address and Interface packages
• Add typedoc syntax to classes we want to hide/show
• Improve docs on classes/methods
• Generate API docs

This is a proof of concept hence having only implemented it in 2 packages. Should we be happy with the implementation, we can extend this by autogenerating the vitepress links (the plugin that does is out of date with the latest version of typedoc but is not difficult to implement). There is also room for improvement of our usage of typedoc syntax inside these classes.

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟢	Statements	83.55% (-1.28% 🔻)	4261/5100
🟡	Branches	62.71% (-0.07% 🔻)	624/995
🟡	Functions	72.84% (+3.78% 🔼)	724/994
🟢	Lines	83.68% (-1.3% 🔻)	4077/4872

Test suite run success

1049 tests passing in 181 suites.

Report generated by 🧪jest coverage report action from 7402047

[arboleya]

Looking beautiful.

I didn't review yet, just quickly glanced over it, here are some preliminary comments:

1. Should we commit the generated MD files inside src/api/classes? Perhaps these could be generated only in CI before publishing. What do you think?
2. There seem to be a couple of annotations like this:

[arboleya]

1. Should we commit the generated MD files inside src/api/classes?

Another indication this may be optimal is that these files contain dynamic links such as:

• https://github.com/FuelLabs/fuels-ts/blob/bef034a9/packages/address/src/address.ts#L27

Due to the blog part (bef034a9), files will appear modified even when unchanged.

Other than that, everything is looking good! Very clean. 👌

[camsjams]

Looks good at the surface level. How does this get updated (similar to what @arboleya mentioned)

Last time we used typedoc it updated alongside the changeset code, but with vitepress I think we can forego any git records right?

[arboleya]

@danielbate Because you're already integrated typedoc in the existent docs build routine:

fuels-ts/apps/docs/package.json

Line 8 in bef034a

"build": "typedoc && vitepress build",

You just need to ignore these two dirs and voilà:

• src/api/classes
• src/api/modules

Everything else is already taken care of.

@Torres-ssf can correct me if I'm missing something.

[danielbate]

@camsjams @arboleya will get the built docs files removed. Only risk is including classes/methods in the docs that were intended to be hidden/internal only, as they won't be included in the review process. But on balance seems worth it to keep the source clean as it's all exposed in source anyways.

[Torres-ssf]

@danielbate Because you're already integrated typedoc in the existent docs build routine:

fuels-ts/apps/docs/package.json

Line 8 in bef034a

"build": "typedoc && vitepress build",

You just need to ignore these two dirs and voilà:

• src/api/classes
• src/api/modules

Everything else is already taken care of.

@Torres-ssf can correct me if I'm missing something.

@arboleya If we are about to not commit the generated API files (which I believe is the way to go), we need to also make Typedoc to generate them on the dev script.

[arboleya]

@Torres-ssf Good point!

@danielbate Maybe something like this would do the trick:

  "dev": "nodemon --config nodemon.config.json -x 'typedoc && vitepress dev'",

[danielbate]

@Torres-ssf @arboleya Any reason they were included prior, as I can see they were removed when we moved to vitepress in #811?

[arboleya]

IIRC, @Torres-ssf changed the way we publish to GH pages, which made it possible.

[danielbate]

I'll pick up the new eslint warnings generated by the implementation of tsdoc in #1125