Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: WIP added a figure that gives an overview of getting started setup #1096

Closed
wants to merge 2 commits into from
Closed

feat: WIP added a figure that gives an overview of getting started setup #1096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bcd6cee
feat: added a figure that gives an overview of getting started setup
amessbee May 16, 2024
265ce26
fix: Updated font size in getting_started_overview.png
amessbee May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added main/guides/getting-started/assets/getting_started_overview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions main/guides/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

![An Overview](./assets/getting_started_overview.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting diagram.

How did you edit it?
I prefer that we check in the source of diagrams.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Member

@dckc dckc May 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. I will look into and get back.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🚀

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for valuable feedback - will incorporate it. Cheers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... 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:

image

Should there be fewer top-level sections? Should the headings change?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • "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"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... 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:


## Platform Requirements

Currently Agoric supports macOS and Linux (including [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/about)). This tutorial is based on an installation of [Ubuntu 22.04 LTS](https://ubuntu.com/download/desktop). If you're using a different operating system, some variation may be required.
Expand Down
Loading