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

docs: Quick start guide for up page #1573

Merged
merged 6 commits into from
Aug 15, 2023
Merged

docs: Quick start guide for up page #1573

merged 6 commits into from
Aug 15, 2023

Conversation

spalladino
Copy link
Collaborator

@spalladino spalladino commented Aug 15, 2023

Adds a quick start guide for the up page, to be embedded there instead of listed in docs.

Related to #1406

@spalladino
Copy link
Collaborator Author

Thanks @iAmMichaelConnor, just added the suggestions! I also added some optional tweaks to code blocks, to make it easy to copy them into the static up page. It looks like this in the Docusaurus now:

Screenshot from 2023-08-15 13-27-57

@@ -0,0 +1,23 @@
# Quick start

:::info This guide is meant to be included in the up.aztec.network site and not in the main documentation.
Copy link
Contributor

Choose a reason for hiding this comment

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

We'll also need the curl command to install and start the sandbox.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Agree, that'll be separate in the up page

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh sorry, I've misunderstood. So this markdown file will be embedded into the up.aztec.network page, somehow?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Copy-paste :-/

@spalladino spalladino enabled auto-merge (squash) August 15, 2023 16:43
@iAmMichaelConnor
Copy link
Contributor

Looks good to me!
I imagine Josh and others will want to suggest some tweaks over the coming weeks. But I think this is a great starting point.
Excited to see how it looks on the up-dev site.

@spalladino spalladino merged commit b102517 into master Aug 15, 2023
@spalladino spalladino deleted the palla/up-quick-start branch August 15, 2023 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants