Skip to content

Commit

Permalink
docs: redo (mostly) everything (#604)
Browse files Browse the repository at this point in the history
Co-authored-by: Eric Warehime <eric.warehime@gmail.com>
Co-authored-by: Alex Johnson <alex@skip.money>
Co-authored-by: David Terpay <35130517+davidterpay@users.noreply.github.com>
  • Loading branch information
4 people authored Jul 24, 2024
1 parent e4ba512 commit 5fa16ab
Show file tree
Hide file tree
Showing 25 changed files with 500 additions and 1,261 deletions.
12 changes: 12 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -306,3 +306,15 @@ deploy-dev:

.PHONY: deploy-dev

###############################################################################
## Docs ##
###############################################################################

docs:
@if which mintlify > /dev/null 2>&1; then \
echo "Starting Mintlify dev server..."; \
cd docs && mintlify dev; \
else \
echo "Mintlify not found. Install at https://mintlify.com/docs/quickstart"; \
fi
.PHONY: docs
185 changes: 0 additions & 185 deletions docs/integrations/dydx.mdx

This file was deleted.

120 changes: 0 additions & 120 deletions docs/integrations/neutron.mdx

This file was deleted.

40 changes: 40 additions & 0 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Introduction
icon: crystal-ball
---

## What is Connect?

**Connect** is an oracle that securely delivers offchain data to onchain applications using a chain's native validator set and security. This documentation will guide you through using Connect; whether you're a **validator** or **developer**.

<CardGroup cols={2}>
<Card title="Validator Setup" icon="circle-nodes" href="/validators/quickstart">
Learn how to setup and run Connect with your infrastructure.
</Card>
<Card title="Using the API" icon="laptop-code" href="/using-connect/high-level">
Learn how to use the Connect API to access data.
</Card>
</CardGroup>

### Features

#### Security <Icon icon="shield-halved"/>

Connect leverages the chain’s security, giving the fastest updates possible, and removing the requirements for any 3rd party systems.

#### Performance <Icon icon="gauge"/>

Connect can support over 2000 currency pairs and price feeds, allowing the launch of thousands of permissionless on-chain markets. Ultimately, the speed of Connect is determined by the speed of your application.

#### Support <Icon icon="headset"/>

Connect comes with a 1-day SLAs for adding new feeds, and 24/7 on-call support and maintenance by the Skip team.

#### UX <Icon icon="user"/>

By leveraging new advancements in consensus like vote extensions & ABCI++, Connect guarantees a millisecond-fresh oracle update every block, allowing applications to build without sacrificing UX for safety.


## Ready to Connect?

If you're interested in using Connect, please check out our [website](https://skip.build) and reach out to us on [discord](https://discord.gg/PeBGE9jrbu) to get started.
Loading

0 comments on commit 5fa16ab

Please sign in to comment.