Skip to content
This repository has been archived by the owner on Jan 22, 2025. It is now read-only.

[docs] quickstart guides #27592

Merged
merged 9 commits into from
Sep 10, 2022
Merged

[docs] quickstart guides #27592

merged 9 commits into from
Sep 10, 2022

Conversation

nickfrosty
Copy link
Contributor

Problem

The time it takes to get a new developer into the docs and to be productive is too long. Quickstart guides will help

Summary of Changes

  • fixed bug in the custom CardsLayout
  • added "quickstart" page and subpages
  • updated sidebar to add the quickstart guides under the developers sidebar
  • moved the developer's "rent" and "programs" pages from "get started" to "core concepts"
  • added a CTA button on the developers home page linking to the Solana Playground based "Hello World" quickstart guide

@mergify mergify bot added the community Community contribution label Sep 5, 2022
@mergify mergify bot requested a review from a team September 5, 2022 01:54
@nickfrosty
Copy link
Contributor Author

@jacobcreech Should we consider change some of the cards on the developers home page to use any of these quickstart guides?

@jacobcreech jacobcreech requested review from jacobcreech and removed request for a team September 5, 2022 02:26
jacobcreech
jacobcreech previously requested changes Sep 8, 2022
View reviewed changes
Copy link
Contributor

@jacobcreech jacobcreech left a comment

Choose a reason for hiding this comment

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

Looking good. A few nits here and there. Is there a way to have a toggle between Rust <> Playground based on the user, defaulting to Playground? Seems like we also have a bunch of copy the same across the two pages. Are you worried it may affect SEO?

docs/src/getstarted/hello-world.md Outdated

#### Congratulations!

You have successfully setup, built, and deployed a Solana program using the Rust language directly in your browser.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have something that executes the instruction? Otherwise the user won't ever see the "hello world" logged and not have the "aha success!" moment

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ideally, yes. But I think that would require adding another section to this page about setting up, building, and connecting a web3.js app to be able to right? Which we can certainly add, I just figured this was a bit lighter to get through

Copy link
Contributor

Choose a reason for hiding this comment

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

imo we should close the loop on actually logging "Hello World" on the blockchain. The information required to use web3.js in a test shouldn't be too long, but is vital for completing the Hello World tutorial.

At a later date playground will have support for writing JS and Rust tests and we'll be able to leverage that.

docs/src/getstarted/hello-world.md Outdated
keywords: "playground, solana pg, on chain, rust, native program, tutorial, intro to solana development, blockchain developer, blockchain tutorial, web3 developer"
---

For this quickstart guide, we will use [Solana Playground](https://beta.solpg.io), a browser the based IDE, to develop and deploy our Solana program. To use it, you do **NOT** have to install any software on your computer. Simply open Solana Playground in your browser of choice, and you are read to write and deploy Solana programs.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we still call them "quickstart guides" if they're under getting started now?

@nickfrosty
Copy link
Contributor Author

Do we still call them "quickstart guides" if they're under getting started now?

I think it is fine to call them quickstarts in the title and paragraph since they are synonymous. But I can change them away from using the phase all together if you desire

@mergify mergify bot dismissed jacobcreech’s stale review September 9, 2022 00:37

Pull request has been modified.

@mergify mergify bot requested a review from a team September 9, 2022 00:38
jacobcreech
jacobcreech approved these changes Sep 10, 2022
View reviewed changes
Copy link
Contributor

@jacobcreech jacobcreech left a comment

Choose a reason for hiding this comment

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

Awesome work! This will help improve mean time to hello world by a ton

@jacobcreech jacobcreech removed the request for review from a team September 10, 2022 02:35
@jacobcreech jacobcreech added automerge Merge this Pull Request automatically once CI passes and removed community Community contribution labels Sep 10, 2022
@mergify mergify bot added the community Community contribution label Sep 10, 2022
@mergify mergify bot merged commit cf1c441 into solana-labs:master Sep 10, 2022
yihau pushed a commit that referenced this pull request Sep 15, 2022
@nickfrosty @yihau
[docs] quickstart guides (#27592)
05739ff 
* feat(wip): rust quickstart page

* feat: added quickstart pages

* fix: updated cards and card layout

* feat: added quickstart home (and to sidebar )

* fix: updated quickstarts

* fix: renamed to get started

* fix: typos and seo

* fix: JS example to interact with the onchain program
yihau pushed a commit that referenced this pull request Sep 15, 2022
@nickfrosty @yihau
[docs] quickstart guides (#27592)
39c876d 
* feat(wip): rust quickstart page

* feat: added quickstart pages

* fix: updated cards and card layout

* feat: added quickstart home (and to sidebar )

* fix: updated quickstarts

* fix: renamed to get started

* fix: typos and seo

* fix: JS example to interact with the onchain program
yihau pushed a commit that referenced this pull request Sep 15, 2022
@nickfrosty @yihau
[docs] quickstart guides (#27592)
26b5b6d 
* feat(wip): rust quickstart page

* feat: added quickstart pages

* fix: updated cards and card layout

* feat: added quickstart home (and to sidebar )

* fix: updated quickstarts

* fix: renamed to get started

* fix: typos and seo

* fix: JS example to interact with the onchain program
yihau pushed a commit that referenced this pull request Sep 15, 2022
@nickfrosty @yihau
[docs] quickstart guides (#27592)
63ea0b3 
* feat(wip): rust quickstart page

* feat: added quickstart pages

* fix: updated cards and card layout

* feat: added quickstart home (and to sidebar )

* fix: updated quickstarts

* fix: renamed to get started

* fix: typos and seo

* fix: JS example to interact with the onchain program
yihau pushed a commit that referenced this pull request Sep 15, 2022
@nickfrosty @yihau
[docs] quickstart guides (#27592)
c54ad0a 
* feat(wip): rust quickstart page

* feat: added quickstart pages

* fix: updated cards and card layout

* feat: added quickstart home (and to sidebar )

* fix: updated quickstarts

* fix: renamed to get started

* fix: typos and seo

* fix: JS example to interact with the onchain program
yihau added a commit that referenced this pull request Sep 26, 2022
@yihau @nickfrosty @jacobcreech
docs: backporting (#27799)
2ef20f7 
* [docs] Adding content pages under "developing" section (#26816)

* feat: added intro to dApps and programs pages

* style: removed whitespaces and updates MD syntax

* fix: spellcheck

* feat: what is rent page

* fix: fix typos and removed whitespaces

* fix: updated terminolgy

* feat: added what is web 3 page

* fix: removed dapps and web3 pages

* feat: added links to the developing sidebar

* fix: updated text based on comments

* fix: fixed link

* fix: fixed the incorrect/unknown redirects (#26844)

* docs: updated "transaction fees" page (#26861)

* docs: transaction fees, compute units, compute budget

* docs: added messages definition

* Revert "docs: added messages definition"

This reverts commit 3c56156.

* docs: added messages definition

* Update docs/src/transaction_fees.md

Co-authored-by: Jacob Creech <82475023+jacobcreech@users.noreply.github.com>

* fix: updates from feedback

Co-authored-by: Jacob Creech <82475023+jacobcreech@users.noreply.github.com>

* docs: updated absolute routes to local routes (#27004)

* [docs] Docs sidebar/navbar restructure (#27005)

* fix: minor title changes

* fix: updated structure of 2 pages

* fix: proposals page and submitting one

added proposals page and made it clear how to submit one

* fix: minor update to docs home page

* fix: footer links

added more footer links and minor restructure

* fix: sidebar restructure

* fix: removed duplicate geyser link

* fix: sidebars and navbar

final separation of sidebars and updated navbar

* fix: formatting for the navbar icons

* fix: changes some sidebar links to refs

* style: changed order of footer's SPL link

* style: removed comment and fixed whitespace check

* [docs] added commitment page (#27265)

feat: added commitment doc

* [docs] developers home page (#27436)

* feat: developers landing page

* fix: updated links

* fix: updated labels for translateIds

* refactor: updated index page to use Card component

* style: removed whitespace

* refactor: added static labels for developer sidebar items

* feat: developer's sidebar and new layout file

* chore: removed whitespace

* fix: removed duplicate CLI sidebar item

* fix: card shadows and RPC card text

* [docs] quickstart guides (#27592)

* feat(wip): rust quickstart page

* feat: added quickstart pages

* fix: updated cards and card layout

* feat: added quickstart home (and to sidebar )

* fix: updated quickstarts

* fix: renamed to get started

* fix: typos and seo

* fix: JS example to interact with the onchain program

* fix empty link

Co-authored-by: Nick Frostbutter <75431177+nickfrosty@users.noreply.github.com>
Co-authored-by: nickfrosty <nfrostbutter@gmail.com>
Co-authored-by: Jacob Creech <82475023+jacobcreech@users.noreply.github.com>
@acheroncrypto acheroncrypto mentioned this pull request Sep 27, 2022
Merged
@nickfrosty nickfrosty deleted the docs-quickstarts branch December 22, 2022 14:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jacobcreech jacobcreech jacobcreech approved these changes

Assignees
No one assigned
Labels
automerge Merge this Pull Request automatically once CI passes community Community contribution
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nickfrosty @jacobcreech