Comprehensive reference and guide

[masiedu4]

Brief

• Update README file

Activities

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

[changeset-bot]

⚠️ No Changeset found

Latest commit: d61712c

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

[masiedu4]

@tuler review requested

[tuler]

Thanks for the PR.

I think most of the changes should be part of the documentation generated from typescript code.

I didn't have time to setup that generation yet.

[tuler]

This is actually a method of the App interface.
For a reference manual I'd rather have something generated.

[masiedu4]

hi @tuler I pushed some changes

For the auto-generation, are we looking at something like TypeDoc? need some elaborate feedback there. thanks!

[tuler]

Regarding documentation generation I'd experiment three alternatives:

https://jsdoc.app
https://typedoc.org
https://tsdoc.org

[tuler]

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]

Documentation already published at https://deroll.dev