feat: WIP added a figure that gives an overview of getting started setup #1096
Conversation
ghost
requested review from
Deploying documentation with
|
| Latest commit: |
265ce26
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://47a967a1.documentation-7tp.pages.dev |
| Branch Preview URL: | https://msaddoverviewtogettingstarte.documentation-7tp.pages.dev |
| @@ -28,6 +28,10 @@ Before getting started, there are some resources you might want to keep handy in | |||
| - Send us a message on [X](https://twitter.com/agoric) | |||
| - Send an Email to [Developer Relations](mailto://[email protected]) | |||
|
|
|||
| ## Offer Up Setup - Overview | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
Interesting diagram.
How did you edit it?
I prefer that we check in the source of diagrams.
There was a problem hiding this comment.
I created it in miro. I don't see how to download source from there. But I can download PDF which is vector based. Does that work? Or Should I create it somewhere else or find a way to generate SVG or something?
There was a problem hiding this comment.
Miro might be OK, as long as the rest of us have permission to edit it.
I was a little puzzled by the significance of the colors and such (I think I get it now)... I wondered about an ordinary numbered list.
Perhaps something in between?
There was a problem hiding this comment.
Ok. I will look into and get back.
There was a problem hiding this comment.
I like the spirit of this. Its almost like having a table of contents for the getting started tutorial. We may want to consider a common design patter for all of our dev diagrams. I also agree with @dckc a numbered list good suffice for this as well. Good stuff @mudassir-agoric 🚀
There was a problem hiding this comment.
Thank you for valuable feedback - will incorporate it. Cheers.
There was a problem hiding this comment.
... Its almost like having a table of contents for the getting started tutorial.
Well, yes... a big question is why the existing table of contents doesn't suffice:
Should there be fewer top-level sections? Should the headings change?
There was a problem hiding this comment.
- "Installing Prerequisites" could go under "Platform Requirements" (or somehow be combined with it)
- "Installing Dapp Dependencies" could go under "Creating Your Dapp From a Template"
- "Starting a Local Agoric Blockchain" could be shortened to "Blockchain Setup"
- "Starting the Dapp Smart Contract" and "Starting the Dapp" could be combined into 1 top-level heading
- "Setting up a Keplr Wallet Demo Account" could be shortened to "Keplr Wallet Demo Account" or "Demo Wallet Setup"
There was a problem hiding this comment.
... We may want to consider a common design patter for all of our dev diagrams.
I think @ivanlei suggested that a while back. I guess it should have its own issue:
This is a WIP and I need feedback.
I am thinking of adding an overview figure in the getting start docs. Have a look and let me know what you think.