make-software / casper-wallet

Securely manage your CSPR tokens, interact with dapps, and sign transactions with Casper Wallet, the go-to self-custody wallet for the Casper Network.
https://casperwallet.io
Apache License 2.0
22 stars 5 forks source link

Investigate solutions for implementing a documentation portal #435

Closed adammake closed 1 year ago

adammake commented 1 year ago

We anticipate that Casper dapp developers will want to start integrating Casper Wallet as users begin making the switch from Signer to Wallet. We should plan on having a documentation portal ready as close to the CW launch date as possible.

The purpose of this ticket is to determine the best approach for standing up a new documentation site. Is there a third party that could be leveraged? We agree that the https://docs.casperlabs.io/dapp-dev-guide/ format is a good benchmark.

Requirements: Define a proposal (or list a few options) for implementing a documentation portal which would live on docs.casperwallet.io. Ultimately we want to know the fastest path to a quality documentation portal similar to https://docs.casperlabs.io/dapp-dev-guide/ (sans the top nav menu)

adammake commented 1 year ago

@mrkara @mssteuer curious if you know of any third parties we could leverage to quickly stand up a quality documentation portal for Casper Wallet? We need to start thinking of an approach for this.

mrkara commented 1 year ago

We can use GitHub pages with a suitable Jekyll theme like the ones here: https://jekyllthemes.io/jekyll-documentation-themes

It will be ready to be filled with content pretty quickly.

We could also look into using what https://docs.casperlabs.io/dapp-dev-guide/ uses: https://docusaurus.io/ (This is also deployable to GitHub pages.)

adammake commented 1 year ago

I'm liking https://just-the-docs.github.io/just-the-docs/docs/ui-components and https://docusaurus.io/ from a usability standpoint. Curious to hear @piotrwitek thoughts.

piotrwitek commented 1 year ago

Docsaurus is the most popular and one of the best docs frameworks. It's a solid choice. Just the docs also look like an interesting option.

adammake commented 1 year ago

@piotrwitek please close this if we are going with Docsaurus.