primitivefinance / rmm-docs

Primitive and RMM Protocol Documentation - Crypto Derivatives without Counterparties

description
Introduction of Primitive

Primitive built the Replicating Market Maker protocol, a scalable and efficient solution to on-chain derivatives.

Table of contents

• What is Primitive?

FAQ

• General
• Providing Liquidity
• Creating New Pools
• Replicating Market Makers
• Research
• Security
• Frontend SDK
• Brand Assets
• Community
• Glossary

Technical

• Core
  • PrimitiveEngine
    • Swap
  • PrimitiveFactory
  • libraries
• Manager
  • PrimitiveManager
• Testing Environment
  • Context loading (fixtures)
  • Mocha and Chai
  • Parallelization
  • Units and unit conversion

Deployments

• Deployed Contracts

rmm-docs's Issues

Add a tutorial for liquidity management in Solidity

Add to the docs a step by step tutorial explaining how to write a Solidity contract to allocate and remove liquidity from RMM pools.

Add a tutorial for swapping in Solidity

Add a step by step tutorial explaining how to swap tokens from RMM pools using Solidity.

Add user tutorials (liquidity management, swapping, etc)

We should have videos showing how to allocate / remove liquidity from pools, how to swap tokens, etc...

Tables style is not finished

I've started to style the tables but I haven't finished. Some details are still left (strips, etc) and some colors are off.

Update rebalance section in rmm to update "static fee" which can now be chosen by pool creator

Syntax highlighting could be changed

We are currently using Dracula and GitHub themes (from Prism module) for the syntax highlighting, however these themes don't really match our branding and could be changed, or even better replaced by a custom theme.

Improve the glossary

The glossary is a bit empty and could be improved. More definitions could be added to help users, especially beginners.

Layout is broken on mobile

When browsing the docs on mobile, the layout is broken (c.f. https://pasteboard.co/xuMPWMEI2BOT.png), not sure if this is coming from the navbar itself (use Primitive button) or the content of the page.