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.

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

up.aztec.network page #1406

Closed
iAmMichaelConnor opened this issue Aug 3, 2023 · 10 comments
Closed

up.aztec.network page #1406

iAmMichaelConnor opened this issue Aug 3, 2023 · 10 comments
Assignees
Labels
A-documentation Area: relates to documentation

Comments

@iAmMichaelConnor
Copy link
Contributor

Write a 'quick start' guide for how someone can first install and use the Sandbox, via the CLI. This guide should be hosted on our 'up' page.

Crucially, it should cover these points, very succinctly, with copy-paste commands all the way.

  • What is the sandbox?
  • What are prerequisite dependencies, before running the aztec command? How do I install those dependencies?
  • How to download the sandbox?
  • How to run the sandbox?
  • How to deploy your first Noir contract to the sandbox (one of our pre-built contracts)?
  • How to verify that your deployment worked?
  • How to send a tx?
  • How to verify that the tx was sent?
  • How to verify that the tx was 'mined'?
  • How to query information about the result of the tx?
  • How to make a call to a 'view' function?
  • Where do I go for more info (link to the docs.aztec.network)

We'll also need to tidy up the graphics, add a robots.txt, create an open-graph-meta-tag, and other 'websitey' considerations that I'm not personally too familiar with.

@iAmMichaelConnor iAmMichaelConnor added the A-documentation Area: relates to documentation label Aug 3, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Aug 3, 2023
@iAmMichaelConnor
Copy link
Contributor Author

Just to reiterate. The intention of this is a very direct set of to-the-point instructions which fits on a single page: the up.aztec.network page.
A more embellished version of this very same explanation can also be repeated in the docusaurus docs

@PhilWindle PhilWindle moved this from Todo to In Review in A3 Aug 13, 2023
@PhilWindle PhilWindle moved this from In Review to Done in A3 Aug 13, 2023
@iAmMichaelConnor iAmMichaelConnor changed the title Aztec Sandbox Quick start guide up.aztec.network page Aug 15, 2023
@iAmMichaelConnor iAmMichaelConnor moved this from Done to Todo in A3 Aug 15, 2023
@iAmMichaelConnor
Copy link
Contributor Author

iAmMichaelConnor commented Aug 15, 2023

Rephrasing this Issue to focus on getting the up.aztec.network page polished.
A very succinct quick start guide (taking inspiration from the more-detailed quick-start guide that Phil wrote).
All the other websitey stuff above.

@iAmMichaelConnor
Copy link
Contributor Author

Oh, just noticed this is a duplicate of #1565

spalladino added a commit that referenced this issue Aug 15, 2023
Adds a quick start guide for the up page, to be embedded there instead
of listed in docs.

Related to #1406

---------

Co-authored-by: Michael Connor <[email protected]>
@spalladino spalladino moved this from Todo to In Review in A3 Aug 15, 2023
@iAmMichaelConnor
Copy link
Contributor Author

robots.txt still needed?

@spalladino
Copy link
Collaborator

I believe not, it's a single page and we want it to be indexed, which is the default behaviour if you don't specify anything. @jonybur could you confirm?

@jonybur
Copy link
Contributor

jonybur commented Aug 16, 2023

@spalladino yes that's accurate

@PhilWindle
Copy link
Collaborator

@spalladino @jonybur @iAmMichaelConnor What's the status of this issue at the moment? Is there anything to be done for this?

@spalladino
Copy link
Collaborator

@PhilWindle we're waiting on work from Cooper and Jon, that should lead to actionables for Matt and Jony. I'd close this issue, since most of what's doable on our end is done.

@PhilWindle PhilWindle assigned jonybur and unassigned spalladino Aug 22, 2023
@PhilWindle PhilWindle moved this from In Review to In Progress in A3 Aug 22, 2023
@iAmMichaelConnor
Copy link
Contributor Author

Copying a message from slack:

I think it just needs some prettification (in its current state it looks like a page from 1996 😅).
https://up-dev.aztec.network/?auth=UBJPoa8DHn3ZzUBzhwhN6Hzz3gVRe2Hj

  • Update font to not be some gross times new roman font
  • Maybe make the font bigger?
  • Make all headings and subheadings the same text colour (some are purple, some are black)
  • Make all code snippets have a background colour which is different from the background colour of other text (see this example: https://aztec-docs-dev.netlify.app/dev_docs/getting_started/cli)
  • Make each code snippet copyable (with a 'copy' button)
  • Update the copyright notice at the bottom of the page
  • Update the graphics / background art
  • Double-check the thumbnail art that accompanies a hyperlink to the page (see example at the bottom of this message, and check that this is in line with our preferred graphics and messaging)
  • Update the text that accompanies a hyperlink to something like: "Aztec Sandbox: a local Aztec blockchain, for building and testing private smart contracts and dapps." :man-shrugging:

@iAmMichaelConnor
Copy link
Contributor Author

Some nice prettification has happened. We might still want to make it look even more polished before public release, but I'll close this issue.

@github-project-automation github-project-automation bot moved this from In Progress to Done in A3 Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: relates to documentation
Projects
Archived in project
Development

No branches or pull requests

5 participants