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

Update Intro section and add concepts #1782

Merged
merged 10 commits into from
Nov 6, 2024
Merged

Update Intro section and add concepts #1782

merged 10 commits into from
Nov 6, 2024

Conversation

srinjoyc
Copy link
Contributor

@srinjoyc srinjoyc commented Oct 30, 2024

This PR aims to refresh the content on the gentle introduction page by separating out conceptual information to a new concepts section. While the themes of the content and general structure was preserved, several edits are made to improve readability, update key items based on new information, and align better with the developer journey.

Updates:

  • In a nutshell section revised to 3 points reflective of top value props of stylus
  • Use cases are more detailed and aligned to value props, with a focus on efficient on-chain verification, DeFi instruments, and high-performance on-chain logic (reflects what most builders are using Stylus for and would be effective in doing so), linking to a specific case study.
  • Offers a step-by-step guide on getting started with direct links to resources like the quickstart, examples, tutorials, and community channels (Telegram, Discord, GitHub). Note: Some of these will need to be updated before merging to master (relies on other content section like tutorials existing).
  • Contains more hyperlinks to resources
  • Actively seeks developers for building and contributing, emphasizing the $5M grant funding through the Stylus Sprint.
  • Updates some language

Removes

  • Public Preview banner from the gentle introduction page
  • Conceptual content on 'how Stylus works' to a new page

Copy link

cla-bot bot commented Oct 30, 2024

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: srinjoyc.
This is most likely caused by a git client misconfiguration; please make sure to:

  1. check if your git client is configured with an email to sign commits git config --list | grep email
  2. If not, set it up using git config --global user.email email@example.com
  3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

Copy link

vercel bot commented Oct 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
arbitrum-docs ✅ Ready (Inspect) Visit Preview Nov 6, 2024 6:30pm

Copy link

cla-bot bot commented Nov 4, 2024

Thank you for your pull request and welcome to our community. We could not parse the GitHub identity of the following contributors: srinjoyc.
This is most likely caused by a git client misconfiguration; please make sure to:

  1. check if your git client is configured with an email to sign commits git config --list | grep email
  2. If not, set it up using git config --global user.email email@example.com
  3. Make sure that the git commit email is configured in your GitHub account settings, see https://github.com/settings/emails

@srinjoyc srinjoyc marked this pull request as ready for review November 4, 2024 14:17
@srinjoyc srinjoyc changed the title [draft / wip] Update Intro section and add concepts Update Intro section and add concepts Nov 4, 2024
To keep up with the latest announcements and updates about Stylus:
### Getting Started
1. Utilize our [quickstart](https://docs.arbitrum.io/stylus/stylus-quickstart), [examples](https://docs.arbitrum.io/stylus/stylus-quickstart), and [tutorials](https://docs.arbitrum.io/stylus/stylus-quickstart) to help you start building.
2. Join our Stylus Developer [Telegram](t.me/arbitrum_stylus) group and [Arbitrum Discord](https://discord.gg/arbitrum) for support as well as the official Arbitrum ([@Arbitrum](https://twitter.com/arbitrum)) and Arbitrum Developers ([@ArbitrumDevs](https://twitter.com/ArbitrumDevs)) X accounts for announcements.
Copy link
Contributor

Choose a reason for hiding this comment

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

Absolutely links like this need to be like https://t.me/arbitrum_stylus

Copy link
Contributor

Choose a reason for hiding this comment

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

That's why the vercel preview failed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ty! fixed

Copy link
Contributor

@anegg0 anegg0 left a comment

Choose a reason for hiding this comment

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

This overhaul helps put the right info in front of the right users, I think it's a great job.
I added a few nits, but LGTM

srinjoyc and others added 3 commits November 6, 2024 03:15
Co-authored-by: Gaël Blanchemain <anegg0@users.noreply.github.com>
Co-authored-by: Gaël Blanchemain <anegg0@users.noreply.github.com>
Co-authored-by: Gaël Blanchemain <anegg0@users.noreply.github.com>
@srinjoyc srinjoyc merged commit a53b5e3 into Stylus-V2 Nov 6, 2024
2 checks passed
@srinjoyc srinjoyc deleted the Stylus-V2-Srinjoy branch November 6, 2024 22:45
@srinjoyc srinjoyc mentioned this pull request Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants