rollkit / docs

Documentation for Rollkit - a modular framework for rollups.
https://rollkit.dev
34 stars 49 forks source link

EPIC: docs improvements #356

Open jcstein opened 6 months ago

jcstein commented 6 months ago
### Tasks
- [ ] https://github.com/rollkit/docs/issues/361
- [x] Cut out what is not necessary due to improved CLI (as an example, the existing gm tutorial will be changed up a lot) (done in #360)
- [x] Minimize software packages to be installed in the first few tutorials (done in #360)
- [x] Add docs around the improved CLI (done in #360)
- [x] Streamline CLI installation similar to `bash -c "$(curl -sL https://docs.celestia.org/celestia-node.sh)"` (done in #360)
- [x] remove the tutorial overview page (done in #360)
- [x] edit or remove readme page to reduce duplicate infos
- [x] add specs to menu rollkit.github.io/rollkit (done in #360)
- [x] remove the glossary (done in #360)
- [x] merge introduction into learn (done in #360)
- [x] Create a tutorial for just getting tokens on the cosmwasm testnet (IMHO this already exists on the testnet page)
- [ ] https://github.com/rollkit/docs/pull/367
- [ ] https://github.com/rollkit/docs/issues/185
- [ ] Revise "about rollkit" page
- [ ] Minimize steps in the tutorials
- [ ] make repos of demos/tutorials where appropriate. clean commits e.g. "feat: step 1"
- [ ] add diagrams, beginning with excalidraw diagrams
- [ ] local explorer packaged in a CLI
- [ ] Create a sandbox environment for docs
- [ ] Continue to implement diataxis.fr in the docs
- [ ] Consider switching frameworks
- [ ] https://github.com/rollkit/docs/issues/444
jcstein commented 6 months ago

tutorial funnel

  1. CosmWasm/Rollkit testnet
  2. Get coins from a faucet, and use the CLI to interact with the token and rollup
  3. Make your own chain with a token and own name
  4. Use ibc between testnets
  5. IBC connection guide to the Rollkit testnet with your custom chain
  6. Make the token do something
  7. Make the token do something more complex
jcstein commented 6 months ago

da onboarding ideas

  1. Remove light node for the quickstart tutorials, use a reliable RPC instead. Requires fewer dependencies
  2. Then add a light node into the setup
  3. Alternatively, build in celestia-node into the Rollkit CLI and allow some infrastructure to auto-fund the account that is used
Manav-Aggarwal commented 2 months ago

Add how to guides for:

  1. Turn your cometBFT app into a rollkit app
  2. Use ignite to create a rollkit app
jcstein commented 2 months ago

🫡 https://github.com/rollkit/docs/issues/444 happy to close this issue, too, if it helps to make a new one for new quarter, etc.