Fix docs generation

[shazarre]

Description

This PR aims at fixing docs generation due to typescript upgrade and typedoc module no longer working in the version that the project was using.

Other changes

Removed linkdocs.ts script as SUMMARY.md file is no longer generated by typedoc markdown plugin due to the update and so it doesn't make any sense to keep it. Removed its usages, script(s) and reference in the docs.

Tested

Tested locally by running the command.

Related issues

• Fixes yarn docs command is failing #72

Backwards compatibility

It's backwards compatible as no public API is affected.

Documentation

Format of the autogenerated docs is changed due to the updates in the typedoc and corresponding markdown plugin.

[changeset-bot]

⚠️ No Changeset found

Latest commit: c5e2de9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[socket-security]

Removed dependencies detected. Learn more about Socket for GitHub ↗︎

🚮 Removed packages: [email protected], [email protected]

[aaronmgdr]

i didnt review the md files themselves but the setup seems good

[arthurgousset]

I'll take a look at the generated files 👍

[arthurgousset]

Notes-to-self (things out of scope for this PR)

1. In typedoc.json there is an option "githubPages": false. I expect, it relates to automatically publishing the generated docs to a Github Page. This issue has an interesting discussion section on this topic:

• Official Github Action for zero-config publishing to GH Pages TypeStrong/typedoc#1485
• someone in the discussion linked tsdocs.dev, which generates and renders docs on the web
• for example: https://tsdocs.dev/docs/@celo/contractkit/6.0.0/index.html
  

2. I see that package.json has a docs script

"scripts": {
   
    "docs": "yarn run --top-level typedoc",
    
  },

• Question: Check if this script is ever run in CI (not necessarily every time), so that docs are automatically updated and don't need to be manually generated/committed.

[arthurgousset]

Generated docs look good to me

[arthurgousset]

Generated docs look good to me

[aaronmgdr]

#8 handles the Run in CI