Kk/auto generate api reference

[krzkaczor]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: be809ff

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

[hasparus]

@krzkaczor could you take a look at this? There's still the case of encoding special characters, but it's some progress. I'll test it more thoroughly tomorrow morning, but I suppose it's ready for review.

[krzkaczor]

Good progress! Still, there is some work to do on the readability of the output (see images, the former is so much easier to skim) but definitely, we are getting closer!

One note is that I think we will need to add a little bit of handcrafted configuration to the generator. For example not is a modifier, not a validator, and should be listed as such.

Previous:

Current:

[hasparus]

We've reached the limit of parsing files by regex — I added a few hacks to make the API reference look good. I'm unhappy with it, but I suppose it's fine for now.

[hasparus]

@krzkaczor I deployed this branch here: https://earljs-docs-hasparus1.vercel.app/docs/api/api-reference

[krzkaczor]

LFG! I love how the new api reference reads.

I am not 100% sure if I like how matchers and validators got split up to different files - now implementation is in one file and docs in another :/ I have strong header files vibes. But I don't see an easy, better solution.

[krzkaczor]

👍