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

Jump to bottom

Stylus V2 New IA #1804

Merged
merged 83 commits into from
Dec 9, 2024
Merged

Stylus V2 New IA #1804

merged 83 commits into from
Dec 9, 2024

Conversation

srinjoyc
Copy link
Contributor

@srinjoyc srinjoyc commented Nov 6, 2024 •
edited
Loading

Stylus Documentation Update

This update reorganizes the Stylus section of the documentation to improve structure and follow conventional information architecture (IA). The changes minimally modify existing content while integrating new content from SBE.

Updates

  • Introduction: See PR #1782 for specific updates.
  • SBE script to pull in application examples as well as the basic examples from before.

Removes

  • cli-tools-overview
  • "Public Preview" mentions from Stylus docs and the public-preview doc. Some references remain and should eventually be removed.

Reorganization

Moved Content:

  • Arbiscan Contract Verification: Moved to Tutorial.
  • Other Supported Languages: Moved to Tutorial.
  • Run a Stylus Dev Node: Moved to Tutorial.
  • Troubleshooting: Moved to Reference.
  • Source Code Repository: Moved to Reference.
  • Concepts from Gentle Introduction: Now under How Stylus Works.
  • Gas and Ink Overview: Now under Concepts > How Stylus Uses Gas.

New Additions

  • Awesome Stylus Link: Added to Examples.
  • Call basic example from SBE added to Rust SDK.
  • New examples added:
    • ERC20
    • ERC721
    • Multi-Call
    • Vending Machine

@cla-bot cla-bot bot added the s label Nov 6, 2024
@vercel Vercel
Copy link

vercel bot commented Nov 6, 2024 •
edited
Loading

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

Name Status Preview Updated (UTC)
arbitrum-docs ✅ Ready (Inspect) Visit Preview Dec 9, 2024 7:25pm

srinjoyc and others added 14 commits November 15, 2024 07:30
@srinjoyc
[wip] Added new file for concepts, moved content over from gentle int…
73bb2eb 
…ro and modified the intro
@srinjoyc
Final proposed changes to the introduction and addition of How It Wor…
b7b13fb 
…k Stylus page
@srinjoyc
removed concepts section for now, will keep concept page to a single one
2f9eef9
@srinjoyc
fixed sidebar and removed (rust) from quickstart label
417df46
@srinjoyc
fixed tg link
0fe43f1
@srinjoyc
[wip] scaffold new sidebar
236765e
@srinjoyc
[wip] scaffold new sidebar
2d37ea3
@srinjoyc
Modified SBE script handler to include applications and added these t…
69d8708 
…o the sidebar
@srinjoyc
updated to proper casing for sidebar titles
446af3f
@srinjoyc
added concepts section and a missed concepts section on gas
c592997
@anegg0 @srinjoyc
fix: format
505abef
@srinjoyc @anegg0
Update arbitrum-docs/stylus/stylus-gentle-introduction.md
f077a33 
Co-authored-by: Gaël Blanchemain <[email protected]>
@srinjoyc @anegg0
Update arbitrum-docs/stylus/stylus-gentle-introduction.md
511e0c4 
Co-authored-by: Gaël Blanchemain <[email protected]>
@srinjoyc @anegg0
Update arbitrum-docs/stylus/concepts/how-it-works.md
a534610 
Co-authored-by: Gaël Blanchemain <[email protected]>
@srinjoyc
Copy link
Contributor Author

I ran yarn format in the website directory and tried manually running prettier on the file - it seems to product no warnings / errors locally. Not sure what the issue is..

joshuacolvin0
joshuacolvin0 approved these changes Dec 4, 2024
View reviewed changes
Copy link
Member

@joshuacolvin0 joshuacolvin0 left a comment

Choose a reason for hiding this comment

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

LGTM

pete-vielhaber
pete-vielhaber approved these changes Dec 9, 2024
View reviewed changes
Copy link
Contributor

@pete-vielhaber pete-vielhaber left a comment

Choose a reason for hiding this comment

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

  • Made a single suggestion

anegg0
anegg0 requested changes Dec 9, 2024
View reviewed changes
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.

I suggested a few grammar fixes. Once those have been addressed, it all LGTM.

@srinjoyc
standardized up arrow html element in sidebar for other section links…
a8b249e 
…, moved around some section into CLI from reference
@srinjoyc srinjoyc requested a review from anegg0 December 9, 2024 18:40
@srinjoyc srinjoyc merged commit 8fb9f61 into master Dec 9, 2024
4 checks passed
@srinjoyc srinjoyc deleted the Stylus-V2 branch December 9, 2024 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@anegg0 anegg0 anegg0 approved these changes

@joshuacolvin0 joshuacolvin0 joshuacolvin0 approved these changes

@pete-vielhaber pete-vielhaber pete-vielhaber approved these changes

Assignees
No one assigned
Labels
s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@srinjoyc @CLAassistant @anegg0 @joshuacolvin0 @pete-vielhaber @hkalodner