Improve Katana Documentation

ponderingdemocritus commented 4 months ago

In depth information about Katana

[x] 1.0.0 Spec including RPC 6.0
[ ] How Katana works as an L3 including persistent storage and genesis setup examples
[ ] Point to Alpha L3s as examples (Dope World, Realms World)
[x] How Katana works as a development network
[x] Contributing to Katana Core
[ ] Adding Katana to a wallet provider (Argent X), including images and a basic example
[ ] Example of adding Katana as a network into Starknet React
[ ] Spinning a Katana up on slot

aji70 commented 2 months ago

i would love to be assigned a task

ponderingdemocritus commented 2 months ago

Please ! @aji70 try tackle one of the issues

aji70 commented 2 months ago

okay then @ponderingdemocritus

aji70 commented 2 months ago

@ponderingdemocritus i have written something about How Katana works as an L3 including persistent storage and genesis setup examples where should i push it to in the book?

kariy commented 2 months ago

@ponderingdemocritus i have written something about How Katana works as an L3 including persistent storage and genesis setup examples where should i push it to in the book?

hey @aji70 thanks for wanting to help on this!

the list above might not be up-to-date but have you seen the genesis and storage modes sections in the book?

im curious on what you've written and would consider adding them if they're meaningful and haven't already been included in the book!

feel free to open a PR and extend those sections, or create new pages if it make sense.

juandiegocv27 commented 2 months ago

Hi, @ponderingdemocritus and @kariy,I'm thrilled to assist with spinning up a Katana node on slot and have drafted a simplified guide for it. My goal is to create something straightforward and user-friendly, possibly with a quick-start script to help first-timers get up and running without a hitch. I’d be glad to get your input and work together to enhance the setup process.

kariy commented 2 months ago

Hi, @ponderingdemocritus and @kariy,I'm thrilled to assist with spinning up a Katana node on slot and have drafted a simplified guide for it. My goal is to create something straightforward and user-friendly, possibly with a quick-start script to help first-timers get up and running without a hitch. I’d be glad to get your input and work together to enhance the setup process.

Hi @juandiegocv27

Yes, more documentations/examples on slot is always appreciated. Though i dont think we'd need a start script, I think it'd be helpful if you could help improving the CLI references for slot.

As you can see in here, the docs are quite lacking compared to sozo/katana. Ideally we want to have slot commands be documented the same way as sozo, where each of the possible commands,arguments, and options are documented clearly along with some short examples.

Would you like to take on this task?

juandiegocv27 commented 2 months ago

I'd love to. For questions where can I contact u? @kariy

kariy commented 2 months ago

I'd love to. For questions where can I contact u? @kariy

awesome! you can contact me thru discord @kariiyy

juandiegocv27 commented 2 months ago

Thank u, could you assing it to me? @kariy @ponderingdemocritus

kariy commented 2 months ago

Thank u, could you assing it to me? @kariy @ponderingdemocritus

feel free to open a new issue specifically for your task and i will assign it to you.

juandiegocv27 commented 2 months ago

Thank u, could you assing it to me? @kariy @ponderingdemocritus

feel free to open a new issue specifically for your task and i will assign it to you.

I created the Issue, and I contact u thru discord, but I think he username is @kariy

Mitish98 commented 4 days ago

I am applying to this issue via OnlyDust platform.

dojoengine / book

Improve Katana Documentation #202