docs: add docs to functions and setup auto-generation of docs

[RebeccaStevens]

PR Checklist

• Addresses an existing open issue:
  • fixes 📝 Documentation: Split API docs out from README.md #56
  • closes chore: enable import/extensions ESLint rule #42 (testing should be necessary as docs are auto-generated)
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

• Added a bunch of JSDoc comments to the functions (didn't touch the "type" code yet as waiting for feat: add missing Type type guards #46).
• Configured typedoc to generate docs from those JSDoc comments.
• Set up a workflow to automatically upload the generated docs to GitHub Pages after each release.

[codecov]

Codecov Report

Merging #70 (612ba6d) into main (6cd0371) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #70   +/-   ##
=======================================
  Coverage   21.99%   21.99%           
=======================================
  Files          18       18           
  Lines         432      432           
  Branches      171      171           
=======================================
  Hits           95       95           
  Misses        315      315           
  Partials       22       22           

Flag	Coverage Δ
4.2.4	21.29% <ø> (ø)
4.3.5	21.52% <ø> (ø)
4.4.4	21.52% <ø> (ø)
latest	21.52% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/comments.ts	0.00% <ø> (ø)
src/compilerOptions.ts	84.21% <ø> (ø)
src/flags.ts	100.00% <ø> (ø)
src/modifiers.ts	0.00% <ø> (ø)
src/nodes/typeGuards/compound.ts	40.90% <ø> (ø)
src/nodes/typeGuards/single.ts	0.00% <ø> (ø)
src/nodes/typeGuards/union.ts	1.94% <ø> (ø)
src/nodes/utilities.ts	0.00% <ø> (ø)
src/scopes.ts	0.00% <ø> (ø)
src/syntax.ts	91.66% <ø> (ø)
... and 6 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[JoshuaKGoldberg]

👏 @RebeccaStevens this is fantastic, thanks for sending it in! The site works great and I like the deployment strategy a lot. Also strong +1 to a lot of the customizations in typedoc.json

Mostly requesting changes around removing redundant tags & filling in some more site info.

[JoshuaKGoldberg]

[Comment] I have a few miscellaneous feature requests that are definitely not blocking for this PR and probably shouldn't go in it even if they're immediately actionable:

• Integrating Konamimojisplosion 😁
• Adding a Ctrl/Cmd+K shortcut for search the way Docusaurus and a lot of other sites / site generators have
• Adding lint rules around tags: avoiding blank/redundant ones and including useful on exported things

...just posting here so I don't forget them.

[JoshuaKGoldberg]

[Praise] This is a great .yml file, thank you 😄. I've been meaning to look into GH page deployments for OpenContributionsProject/opencontributionssite#29...

cc @blackgirlbytes, good timing here!

[JoshuaKGoldberg]

❤️‍🔥 awesome! Really excited to get this in.

[JoshuaKGoldberg]

🔥 This is fantastic, thanks so much @RebeccaStevens! I learned a bunch of things from this PR 😄.

Ready to merge whenever you're happy. 🚀

[RebeccaStevens]

I can't guarantee that the workflow is completely correct. We might have to debug it once this is merged.

[RebeccaStevens]

I can't merge this due to unresolved conversations. I'll resolve them then unresolve them so I can merge this.