[WIP] docs: switched API docs to typedoc and starlight-typedoc

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes 📝 Docs: Migrate /api docs or an equivalent from the old site to the new one #5309
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Very much a draft WIP. Both the current docdash/jsdoc docs and the new TypeDoc generators generate some wacky code. My hope is we can clean up the current docs to be better for both.

[Copilot]

Pull Request Overview

This PR aims to switch the API documentation generation to Typedoc and integrate the starlight-typedoc plugin in order to improve the generated docs.

• Introduces a new Typedoc configuration in typedoc.json.
• Updates JSDoc comments in lib/mocha.js to utilize generics annotations.
• Upgrades documentation dependencies and adapts the Astro configuration to support the new docs generation and sidebar structure.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
typedoc.json	Adds a configuration file to generate API docs using Typedoc.
lib/mocha.js	Updates JSDoc comments by specifying a template for parameter types.
docs-next/package.json	Updates dependency versions and adds the starlight-typedoc package.
docs-next/astro.config.ts	Integrates starlightTypeDoc into the Astro config and updates the sidebar and social links.
docs-next/.gitignore	Ignores the generated API docs folder.

Comments suppressed due to low confidence (2)

docs-next/astro.config.ts:21

• Consider adding a comment explaining the starlightTypeDoc configuration settings to improve clarity and maintainability.

plugins: [
        starlightTypeDoc({
          entryPoints: ["../lib/mocha.js"],
          sidebar: {
            collapsed: true,
          },
          tsconfig: "../tsconfig.json",
        }),
      ],

docs-next/astro.config.ts:126

• [nitpick] Confirm that replacing the API link with a Discord link aligns with the intended user experience, and if so, consider documenting this design decision.

icon: "discord",
          label: "Discord",
          href: "https://discord.gg/KeDn2uXhER",