Comprehensive reference and guide

masiedu4 commented 4 months ago

Brief

Update README file

Activities

This PR sets to provide documentation for the deroll project and its router and wallet functionalities

changeset-bot[bot] commented 4 months ago

⚠️ No Changeset found

Latest commit: d61712c78f3c7cf5d73c2c7acd8b186b6baa060d

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

tuler commented 3 months ago

I configured typedoc myself, using the monorepo guidelines described at https://typedoc.org/api/#md:monorepos--workspaces. I even tried the upcoming beta version, which improves support for monorepos, among other things.

Documentation is generated ok, but I don't like the result very much. I'll try next week to follow another strategy, which is using VitePress for a docs website, and generating markdown from JSDoc into a VitePress website.

If that doesn't work well either, I'll reevaluate the options.

tuler / deroll