Skip to content

Conversation

@anegg0
Copy link
Contributor

@anegg0 anegg0 commented Nov 14, 2025

This PR aims at

  • Bringing all the docs up to date with Stylus-sdk-rs V0.10
  • Adding specific SDK content and removing SBE content
  • Changing content structure
  • Adding specific articles to describe primitives and additional stylus-related concepts.

The proposed temporary structure is as follows:

  • Gentle Introduction
  • Stylus SDK (Rust)
  1. Getting Started
    1. Installation
    2. Hello World
    3. Hello, Cargo Stylus
  2. First App Example (Counter or Vending Machine)
  3. Structure of a Stylus contract
    1. Project layout
    2. Variables
    3. Functions
    4. Modules
    5. Importing packages
    6. Events
    7. Errors
  4. Data Types
    1. Primitives (include Sol & Rust primitives where applicable)
      1. Boolean
      2. Integers
      3. Address (include AddressVM traits from types module)
      4. String
        1. Literals
        2. Hex
    2. Compound types
      1. Tuple
      2. Struct
      3. Array
      4. Vector
      5. Bytes
      6. FixedBytes
    3. Storage
      1. Bool
      2. Uint
      3. Address
      4. Struct
      5. Array
      6. Map
      7. String
      8. Bytes
      9. FixedBytes
    4. Conversions Between Types
  5. Global variables and functions
    1. block
    2. contract
    3. crypto
    4. EVM
    5. msg
    6. tx
    7. debug
  6. Contracts
    1. Calling other contracts
      1. Call
      2. Raw call
      3. Delegate call
      4. Static call
      5. sol_interface
    2. Sending ETH
    3. Factory deploy
    4. Function modifiers
    5. Inheritance (temporary)
    6. Constructors (coming soon)
  7. Writing tests (coming soon)
  8. Advanced
    1. Solidity differences
    2. Recommended packages
    3. Minimal entrypoint contracts
    4. Hostio exports
  9. FAQs
  • Using the CLI
    • Check and deploy
    • Verify contracts
    • Exporting ABI
    • Debugging with replay
    • Optimizing WASM binary size
    • Deploying non-Rust WASM contracts
  • VM Concepts
    • WebAssembly
    • EVM differences
      • Size limits
      • Ink and gas
      • Memory and compute
    • Activation
    • Caching strategy
  • Stylus by Example (external link)
  • Rust crate docs (external link)
  • Source code repository (external link)

Add lint:markdown:fix to the format script to automatically fix
markdown linting issues when running yarn format. This ensures
markdown files are both formatted (prettier) and linted (markdownlint)
in one command.

The new format workflow:
1. Format docs with prettier
2. Format app files with prettier
3. Auto-fix markdown linting issues
4. Verify all files pass prettier check
@vercel
Copy link

vercel bot commented Nov 14, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
arbitrum-docs Ready Ready Preview Dec 12, 2025 5:45pm

@joshuacolvin0 joshuacolvin0 changed the title Stylus v0.1 Stylus v0.10 Nov 20, 2025
Add detailed documentation for all Stylus SDK primitive types including:
- Boolean (bool) with usage examples and Solidity mappings
- Unsigned integers (u8-u128, U256, Uint<BITS, LIMBS>)
- Signed integers (i8-i128, I256, Signed<BITS, LIMBS>)
- Address type with constants and validation examples
- String type with literal and formatting examples
- Bytes types (dynamic Bytes and fixed FixedBytes<N>)
- Hex literal usage examples
- Complete type mapping tables for all primitives
- Best practices for each primitive type
- Type conversion examples

Each section includes:
- Practical code examples
- Solidity type mappings
- Storage size information
- ABI signature details
- Common usage patterns
Add detailed documentation for all Stylus SDK compound types including:
- Tuples with destructuring and pattern matching examples
- Structs using sol! macro with AbiType derivation
- Nested structs for complex data structures
- Fixed-size arrays with iteration and operations
- Vectors (dynamic arrays) with filter, map, and fold operations
- Bytes types (dynamic Bytes and fixed FixedBytes<N>)
- Complete type mapping tables for all compound types
- Best practices for each compound type
- Type conversion helpers and iterator patterns
- Common patterns (batch operations, pagination)

Each section includes:
- Practical code examples from SDK examples
- Solidity type mappings
- ABI signature details
- Memory and gas efficiency considerations
- Complete working examples with nested structures
- Iterator and functional programming patterns
Fixed titles and headers in Stylus documentation to follow sentence case
style guide (first letter capitalized, rest lowercase except proper nouns
and acronyms).

Changes:
- Fixed frontmatter title: "Public preview: What to expect" → "Public preview: what to expect"
- Fixed 9 headers in webassembly.mdx (e.g., "WASM Compilation Target" → "WASM compilation target")
- Fixed 9 headers in deploying-non-rust-wasm-contracts.mdx (e.g., "Why Use Non-Rust Languages?" → "Why use non-Rust languages?")

Proper nouns (Stylus, Rust, WebAssembly, Nitro, etc.) and acronyms (WASM,
SDK, ABI, etc.) remain capitalized as appropriate.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants