Skip to content

setraprotocol/setra-docs

Repository files navigation

Setra Protocol — Documentation

Official documentation for the Setra Protocol — the canonical settlement layer for tokenized equities on Robinhood Chain.

Built with Docusaurus 3.

Quick Start

Prerequisites

  • Node.js >= 18
  • npm or yarn

Install Dependencies

npm install

Local Development

npm start

This starts a local dev server at http://localhost:3000. Most changes are reflected live without restarting the server.

Build

npm run build

Generates static content in the build/ directory.

Deploy

npm run deploy

Documentation Structure

docs/
├── getting-started.md          # Introduction and quick start
├── concepts/
│   ├── dvp-settlement.md       # DVP settlement mechanics
│   ├── sequity-standard.md     # sEquity token standard
│   ├── netting.md              # Multilateral netting engine
│   ├── proof-of-reserves.md    # Reserve attestation framework
│   └── corporate-actions.md    # Automated corporate actions
├── architecture/
│   ├── overview.md             # Contract architecture
│   ├── settlement-flow.md      # Sequence diagrams
│   └── intent-lifecycle.md     # Intent state machine
├── guides/
│   ├── sdk-quickstart.md       # SDK quickstart
│   ├── integrate-dex.md        # DEX integration guide
│   ├── integrate-lending.md    # Lending protocol integration
│   └── register-asset.md       # Asset registration
├── api-reference/
│   ├── index.md                # API overview
│   ├── isettlement.md          # ISettlement interface
│   ├── isequity.md             # ISEquity interface
│   ├── iregistry.md            # IRegistry interface
│   └── sdk.md                  # TypeScript SDK reference
├── security.md                 # Security model
└── faq.md                      # FAQ

Contributing

  1. Fork this repository
  2. Create a feature branch: git checkout -b docs/my-improvement
  3. Make your changes
  4. Submit a pull request

Style Guide

  • Use sentence case for headings
  • Include code examples for all API methods
  • Use admonitions (:::tip, :::warning, :::danger) for callouts
  • Link to related pages at the bottom of each document
  • Keep ASCII diagrams for architecture visualization

License

Documentation content is licensed under CC BY 4.0. Code examples are licensed under MIT.


Built with Docusaurus

About

Setra Protocol documentation - architecture, integration guides, API reference

Topics

Resources

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages