Skip to content

docs: comprehensive reference documentation for all SPEL components #62

@jimmy-claw

Description

@jimmy-claw

Document every public-facing component of SPEL.

Scope

Macros

  • #[lez_program] — all attributes, generated code, constraints
  • #[instruction] — account validation attributes
  • generate_idl!

Framework types

  • Account, AccountWithMetadata, AccountPostState, ChainedCall
  • LezError, LezResult, LezOutput

CLI

IDL format

  • Full schema, discriminators, all fields

FFI / client-gen

  • How to run lez-client-gen, what it generates
  • Using generated clients in Qt/C++

Approach

  1. Inventory all source first
  2. cargo doc for API reference
  3. Human guides in docs/
  4. GitHub Pages via CI

Tracks with #61 (tutorial).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions