Skip to content

Commit

Permalink
clean up some titles, remove superfluous text (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
metachris authored Mar 15, 2024
1 parent 5a84e98 commit 1a98c78
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 45 deletions.
16 changes: 2 additions & 14 deletions docs/concepts/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: How SUAVE Extends Solidity
title: SUAVE Concepts
description: Understand more about SUAVE
keywords:
- explanations
Expand All @@ -9,18 +9,6 @@ keywords:

import DocCardList from '@theme/DocCardList';

Each of the pages in this section describes one of the ways in which SUAVE extends Solidity and gives you, a MEV application developer, unique advantages.
<br />

<DocCardList />

In brief, SUAVE enables you to:

- 🛠 Build blocks on other chains

- 🧑‍💻 Define private compute

- 🕵️‍♀️ Store private data

- 🧩 Interface with many different MEV components, meaning that you can
- ⚡ Plug into existing MEV infra: i.e sending bundles to block builders, relays, validators or sequencers
- 🤖 Build totally new MEV infra: i.e. create unique SUAPPs on SUAVE
12 changes: 10 additions & 2 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ SUAVE is currently in early alpha. The first testnet is called Rigil. Please be

:::


## Explore

<div className="intro-grid">
Expand Down Expand Up @@ -65,7 +66,7 @@ SUAVE is currently in early alpha. The first testnet is called Rigil. Please be
</a>


<a href="/tutorials/suave-standard-library" className="intro-link">
<a href="/tools/suave-std" className="intro-link">
<div className="intro-block">
<div className="intro-image">
<svg
Expand Down Expand Up @@ -191,4 +192,11 @@ SUAVE is currently in early alpha. The first testnet is called Rigil. Please be
</div>
</div>
</a>
</div>
</div>

<br/>
<br/>
<br/>


![logo](/img/social-preview-3.jpg)
19 changes: 9 additions & 10 deletions docs/tools/index.mdx
Original file line number Diff line number Diff line change
@@ -1,38 +1,37 @@
---
title: Explanations
description: Understand more about SUAVE
title: Tools
description: Tools and projects for SUAVE, from Flashbots and the community
keywords:
- explanations
- suave
- concepts
- tools
---

import DocCardList from '@theme/DocCardList';

Here is an up-to-date list of software and repositories to help you build on [SUAVE Rigil](/technical/specs/rigil):
Software and repositories to help you build on [SUAVE Rigil](/technical/specs/rigil):

**SDKs and Tools:**
## SDKs and Tools

- [`suave-std` Solidity Libraries](/tools/suave-std/)
- [Forge](/tools/forge)
- [Golang SDK](/tools/golang-sdk)
- [`suave-viem` TypeScript SDK](/tools/typescript-sdk)

**Docs, examples and code:**
## Docs, examples and code

- [SUAPP Examples Repo](https://github.com/flashbots/suapp-examples)
- [SUAVE Rigil Specs](/technical/specs/rigil)
- [suave-geth](https://github.com/flashbots/suave-geth)

## Community

Here is an up-to-date list of software built by the SUAVE community:
Repositories from the SUAVE community:

1. [SUAVE Playground](https://github.com/halo3mic/suave-playground) by [Miha](https://twitter.com/MihaLotric). This repository serves as a guide for setting up a local environment to build and submit Goerli blocks to Flashbots's relay using Suave.
2. [SUAVE Foundry Template](https://github.com/mehranhydary/suave-template) by [Mehran](https://twitter.com/mehranhydary) is an alternate approach to using Foundry than you'll find in the SUAPP Examples repo.

## Applications
Community projects:

1. So Extra - use SUAVE to buy block extra data on Ethereum test nets (link coming soon).
1. [So Extra](https://so-extra-dapp.vercel.app/) - use SUAVE to buy block extra data on Ethereum test nets.
2. [SUIFT](https://github.com/lstephanian/SUIFT) (Safe User Inception For Tickets) - concert ticketing done better on SUAVE.
2. [Arena X on SUAVE](https://github.com/mehranhydary/arena-suave) by [Mehran](https://twitter.com/mehranhydary/status/1727849740333703310). A MEV application that takes orders from users on any chain, lets searchers execute user orders on any chain, and then returns the outputs to the user.
21 changes: 3 additions & 18 deletions docs/tutorials/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction
description: Get started by learning how to build cool stuff with SUAVE
title: Tutorials
description: Learn how to build things on and with SUAVE
keywords:
- tutorials
- suave
Expand All @@ -10,21 +10,6 @@ keywords:

import DocCardList from '@theme/DocCardList';

:::info

SUAVE is focused on delivering credible, confidential computation that enables you to build better mechanisms. SUAVE enables anyone to build and deploy MEV applications, on a decentralized network, which were not possible until today.

:::

## What can I do with SUAVE?

1. **Deploy more expressive smart contracts.**

- Contracts on SUAVE follow the same rules as on Ethereum, with the added advantage of being able to access additional precompiles available to serve any SUAPP.

2. **Compute confidentially**.
- Public contracts with verifiable logic, combined with confidential data, means that SUAVE can be seen as an open marketplace for mechanisms we can all inspect, collaborate on, and compete with to produce the most efficient MEV applications, while nevertheless protecting everyone's privacy.

## In this section
<br />

<DocCardList />
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ module.exports = async function createConfigAsync() {
routeBasePath: '/',
id: 'docs',
editUrl: 'https://github.com/flashbots/suave-docs/edit/main/',
showLastUpdateTime: true,
showLastUpdateTime: false,
remarkPlugins: [(await import('remark-math')).default],
rehypePlugins: [(await import('rehype-katex')).default],
},
Expand Down

0 comments on commit 1a98c78

Please sign in to comment.