Start adding docs via typedoc

[jnicklas]

This is a first stab at adding docs via TypeDoc.

Unfortunately this uses a frozen in time, outdated fork of TypeDoc, found here TypeStrong/typedoc#1184, because the output generated just isn't very nice, but is pretty great with this fork 🤷‍♂️

It seems like some other projects are also doing this. Not sure what this says about TypeDoc.

It also takes some finagling to get docs for interactors to display in a comprehensible way.

[changeset-bot]

⚠️ No Changeset found

Latest commit: a1c4df8

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

[github-actions]

The preview packages of this pull request have been published.
Click on the following packages for instructions on how to install them:

bigtest

---

Install using the following command:

$ npm install bigtest@typedoc-poc

Or update your package.json file:

{
  "bigtest": "typedoc-poc"
}

---

@bigtest/interactor

---

Install using the following command:

$ npm install @bigtest/interactor@typedoc-poc

Or update your package.json file:

{
  "@bigtest/interactor": "typedoc-poc"
}

---

@bigtest/suite

---

Install using the following command:

$ npm install @bigtest/suite@typedoc-poc

Or update your package.json file:

{
  "@bigtest/suite": "typedoc-poc"
}

---

Generated by 🚫 dangerJS against a1c4df8

[jorgelainfiesta]

How can I preview the docs in a browser, like what command should I run? I tried browsing TypeDoc's website but I couldn't figure it out.

[Gerrit0]

Recommendation: switch to typedoc@beta, which is version 0.20.0-beta.#, and is under active development. I need to update the linked PR to point people towards that...

[taras]

Thank you @Gerrit0!

[jnicklas]

Thanks @Gerrit0, I upgraded to the beta and it works perfectly.

@jorgelainfiesta I don't have any good way of putting these docs online right now. You can run yarn typedoc in packages/bigtest, and it will output the generated docs into packages/bigtest/docs.

[jnicklas]

We'll probably want to add a deploy hook for these!

[jnicklas]

This is by no means done, but I think it's good enough now where we can actually merge this and start working on integrating these docs into the website.

Docs can be generated for the @bigtest/suite, @bigtest/interactor and bigtest packages, by running yarn typedoc in their respective directories.

[jnicklas]

This file is just a placeholder, we'll want to expand this to link to the most relevant parts of the documentation.