Skip to content

Commit

Permalink
Merge pull request #92 from cardano-foundation/design
Browse files Browse the repository at this point in the history
Design and structure
  • Loading branch information
katomm committed Jul 4, 2021
2 parents 33732fb + 4275fcf commit 7cad34c
Show file tree
Hide file tree
Showing 91 changed files with 157 additions and 134 deletions.
11 changes: 0 additions & 11 deletions docs/cardano-integration/overview.md

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
id: overview
slug: /fund-your-project/
title: Fund your Project
sidebar_label: Overview
description: Find out what opportunities are available to get your project funded.
image: ./img/og-developer-portal.png
---

![Cardano Fund your Project](../../static/img/card-funding-title.svg)
![Fund your project](../../static/img/card-fund-your-project-title.svg)

Cardano was already designed with sustainability in mind. The point was to create a system that governs and also finance itself without being dependent on donations. Cardano has a built-in treasury system that gets a constant stream of funds from transactions fees and treasury taxes. This is explained in detail in [treasuries with Bingsheng Zhang](https://www.youtube.com/watch?v=Hyh3h_yX-S0).

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Blockfrost provides API to access and process information stored on the Cardano

[Sign in on Blockfrost](https://blockfrost.io/auth/signin) with your GitHub account. No registration required. Enter a project name and select Cardano mainnet or Cardano testnet, depending on your needs.

![img](../../static/img/getting-started/blockfrost/1-add-project.png)
![img](../../static/img/get-started/blockfrost/1-add-project.png)

## Get your API key

After clicking on `Save Project` you will immediately get your `API KEY`. Save it. You will need this key for every request.

![img](../../static/img/getting-started/blockfrost/2-get-api-key.png)
![img](../../static/img/get-started/blockfrost/2-get-api-key.png)

## Query the latest epoch

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: cardano-developer-community
title: Get Started in the Cardano Developer Community
sidebar_label: Developer Community
description: Get Started in the Cardano Developer Community
description: Get Started in the Cardano Developer Community.
image: ./img/og-developer-portal.png
---

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ import TabItem from '@theme/TabItem';

## Cardano GraphQL

![img](../../static/img/getting-started/dandelion-apis/showcase-graphql-api.png)
![img](../../static/img/get-started/dandelion-apis/showcase-graphql-api.png)

Useful links:

Expand Down Expand Up @@ -80,7 +80,7 @@ Output example:

## Cardano Explorer

![img](../../static/img/getting-started/dandelion-apis/showcase-explorer-api.png)
![img](../../static/img/get-started/dandelion-apis/showcase-explorer-api.png)

Useful links:

Expand Down Expand Up @@ -133,7 +133,7 @@ Output example (REDACTED):

## Cardano Submit

![img](../../static/img/getting-started/dandelion-apis/showcase-submit-api.png)
![img](../../static/img/get-started/dandelion-apis/showcase-submit-api.png)

Useful links:

Expand Down Expand Up @@ -168,7 +168,7 @@ Output example (a transaction id):

## Cardano Rosetta

![img](../../static/img/getting-started/dandelion-apis/showcase-rosetta-api.png)
![img](../../static/img/get-started/dandelion-apis/showcase-rosetta-api.png)

Useful links:

Expand Down Expand Up @@ -223,7 +223,7 @@ Output example:

## Ogmios

![img](../../static/img/getting-started/dandelion-apis/showcase-ogmios-api.png)
![img](../../static/img/get-started/dandelion-apis/showcase-ogmios-api.png)

Useful links:

Expand Down Expand Up @@ -272,7 +272,7 @@ Output example:

## PostgREST

![img](../../static/img/getting-started/dandelion-apis/showcase-postgrest-api.png)
![img](../../static/img/get-started/dandelion-apis/showcase-postgrest-api.png)

Useful links:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you want to avoid compiling the binaries yourself, You can download the lates
- [MacOS](https://hydra.iohk.io/job/Cardano/cardano-wallet/cardano-wallet-macos64/latest)
- [Windows](https://hydra.iohk.io/job/Cardano/cardano-wallet/cardano-wallet-macos64/latest)

This guide assumes you have installed `cardano-node` and `cardano-cli` into your system. If not you can refer to [Installing cardano-node](/docs/getting-started/installing-cardano-node) guide for instructions on how to do that.
This guide assumes you have installed `cardano-node` and `cardano-cli` into your system. If not you can refer to [Installing cardano-node](/docs/get-started/installing-cardano-node) guide for instructions on how to do that.

:::

Expand All @@ -41,7 +41,7 @@ In this section, we will walk you through the process of downloading, compiling

#### Downloading & Compiling

If you have followed the [Installing cardano-node](/docs/getting-started/installing-cardano-node) guide, You should have the `~/cardano-src` directory. If not, let's create a working directory to store the source-code and build for `cardano-wallet`.
If you have followed the [Installing cardano-node](/docs/get-started/installing-cardano-node) guide, You should have the `~/cardano-src` directory. If not, let's create a working directory to store the source-code and build for `cardano-wallet`.

```bash
mkdir -p ~/cardano-src
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you prefer to build everything from source or without docker, please head to

You should now be able to access the dashboard on [http://localhost:1337](http://localhost:1337) with a real-time visualization of some of the server runtime metrics.

![img](../../static/img/getting-started/ogmios/1-dashboard.gif)
![img](../../static/img/get-started/ogmios/1-dashboard.gif)

## Query metrics

Expand Down
23 changes: 12 additions & 11 deletions docs/getting-started/overview.md → docs/get-started/overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
id: overview
slug: /get-started/
title: Get Started
sidebar_label: Overview
description: Get Started
image: ./img/og-developer-portal.png
---
![Cardano Get Started](../../static/img/card-getting-started-title.svg)
![Cardano Get Started](../../static/img/card-get-started-title.svg)

Welcome to the Cardano Developer portal. This category will help you find your way around quickly.

Expand All @@ -24,16 +25,16 @@ Besides cryptographic research, there was game-theoretic research, identity-mana
## What you need to bring
To get the most out of the Cardano Developer Portal, you should have programming experience and a basic understanding of blockchain concepts such as nodes, blocks, signatures, transactions, keys, and hashes.

If you are unfamiliar with these terms, start with the [stake pool course](../stake-pool-operation/overview#stake-pool-course)). It will help you understand basic concepts, even if you don't want to run a stake pool.
If you are unfamiliar with these terms, start with the [stake pool course](../operate-a-stake-pool/#stake-pool-course)). It will help you understand basic concepts, even if you don't want to run a stake pool.

## Cardano is different
If you have experience with other smart contract platforms and want to start building on Cardano, it is vital to know its differences:

- It makes sense to get your head around the [concept of UTxO](../stake-pool-course/lesson-2#the-utxo-model) and later [the extended UTxO model](https://iohk.io/en/blog/posts/2021/04/13/plutus-what-you-need-to-know/).

- [Tokens on Cardano](../native-tokens/overview) are not built with smart contracts. Instead, tokens are native and live on the ledger. The protocol treats them as first-class citizens, like ada. It is quite different from our peers that don’t have native tokens and need to use a smart contract to send tokens.
- [Tokens on Cardano](../native-tokens/) are not built with smart contracts. Instead, tokens are native and live on the ledger. The protocol treats them as first-class citizens, like ada. It is quite different from our peers that don’t have native tokens and need to use a smart contract to send tokens.

- [Native tokens](../native-tokens/overview) use the core infrastructure, and the network has to do everything else. For example, instead of running a smart contract and calling a method called transfer. On Cardano, you are sending a standard transaction. This removes a layer of extra complexity and the risk of human mistakes, as the ledger handles all token-related functions.
- [Native tokens](../native-tokens/) use the core infrastructure, and the network has to do everything else. For example, instead of running a smart contract and calling a method called transfer. On Cardano, you are sending a standard transaction. This removes a layer of extra complexity and the risk of human mistakes, as the ledger handles all token-related functions.


## Why build on Cardano?
Expand All @@ -44,12 +45,12 @@ If you have experience with other smart contract platforms and want to start bui
- Cardano has an energetic community and more than one million wallets. If you stick to specific standards, we are keen to try out and engage with new products. Participating now makes you a first mover.

## What you can do on Cardano today
- You can send and receive [native tokens](../native-tokens/overview), including ada.
- You can issue [native tokens](../native-tokens/overview) and [NFTs](../native-tokens/minting-nfts).
- You can add [metadata to transactions](../transaction-metadata/overview) to give transactions a story, a background or even an identity.
- You can prove the existence of a file, text or any other data at a specific point in time with [transaction metadata](../transaction-metadata/overview). You can even use transaction metadata to validate and verify external physical products and genuine articles.
- You can [setup, manage and maintain a stake pool](../stake-pool-operation/overview) on Cardano.
- You can send and receive [native tokens](../native-tokens/), including ada.
- You can issue [native tokens](../native-tokens/) and [NFTs](../native-tokens/minting-nfts).
- You can add [metadata to transactions](../transaction-metadata/) to give transactions a story, a background or even an identity.
- You can prove the existence of a file, text or any other data at a specific point in time with [transaction metadata](../transaction-metadata/). You can even use transaction metadata to validate and verify external physical products and genuine articles.
- You can [setup, manage and maintain a stake pool](../operate-a-stake-pool/) on Cardano.
- You can delegate your ada to one of the [existing pools](../../showcase?tags=pooltool) and earn rewards.
- You can [vote with your ada](../funding/overview) to distribute over a billion dollars worth of ada from the treasury to fund community-driven proposals on Project Catalyst.
- You can [vote with your ada](../fund-your-project/) to distribute over a billion dollars worth of ada from the treasury to fund community-driven proposals on Project Catalyst.
- You can earn ada rewards by voting on proposals.
- You can get [your project funded](../funding/overview). Every 6 to 8 weeks, projects can be proposed, discussed, and voted on by the Cardano community.
- You can get [your project funded](../fund-your-project/). Every 6 to 8 weeks, projects can be proposed, discussed, and voted on by the Cardano community.
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ image: ./img/og-developer-portal.png
This guide will show you how to run `cardano-node` and `cardano-cli` on your system and some simple examples of how you can interact with the **Cardano** blockchain.

:::note
This guide assumes you installed `cardano-node` and `cardano-cli` into your system. If not, you can refer to [Installing cardano-node](/docs/getting-started/installing-cardano-node) guide for instructions on how to do that.
This guide assumes you installed `cardano-node` and `cardano-cli` into your system. If not, you can refer to [Installing cardano-node](/docs/get-started/installing-cardano-node) guide for instructions on how to do that.
:::

:::important
This guide does not cover the topic of running a block-producing `cardano-node` or running a **Cardano Stake Pool**. For more information regarding that topic, please visit the [Stake Pool Operation](/docs/stake-pool-operation/overview) section.
This guide does not cover the topic of running a block-producing `cardano-node` or running a **Cardano Stake Pool**. For more information regarding that topic, please visit the [Stake Pool Operation](/docs/operate-a-stake-pool/) section.
:::

### Configuration Files
Expand Down Expand Up @@ -133,7 +133,7 @@ In this section, we will use the path `/home/user/cardano` to store all the `car
:::
We will focus on six key command-line parameters for running a node:

**`--topology`**: This requires the path of the `topology.json` file that you have downloaded as instructed [above](/docs/getting-started/running-cardano#configuration-files).
**`--topology`**: This requires the path of the `topology.json` file that you have downloaded as instructed [above](/docs/get-started/running-cardano#configuration-files).

> For example, If you have downloaded the `topology.json` file to the path `/home/user/cardano/topology.json`, then the argument would be something like this:
```
Expand Down Expand Up @@ -287,7 +287,7 @@ To know whether you are fully synced or not, you can check the **Cardano Blockch

Scroll down to the **Latest Blocks** section, and you can find the latest network tip.

![img](../../static/img/cardano-integrations/latest-block.png)
![img](../../static/img/integrate-cardano/latest-block.png)

:::important
Before making any transactions, make sure you are fully synced to the blockchain network.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ image: ./img/og-developer-portal.png
In this guide, we will show you how to create a **Cardano** wallet, receive some `tADA` (**test ADA**) in the `testnet` network and send basic example transactions. We will explore tools like `cardano-cli` and `cardano-wallet` on how they can help with these functionalities.

:::note
This guide assumes you have installed `cardano-node` and `cardano-cli` into your system. If not you can refer to [Installing cardano-node](/docs/getting-started/installing-cardano-node) guide for instructions on how to do that.
This guide assumes you have installed `cardano-node` and `cardano-cli` into your system. If not you can refer to [Installing cardano-node](/docs/get-started/installing-cardano-node) guide for instructions on how to do that.

You must also connect your `cardano-node` to the `testnet` network and make sure it is fully synchronized.

If you are not sure how to do that, It is recommended to read [Running cardano-node](/docs/getting-started/running-cardano) guide before proceeding.
If you are not sure how to do that, It is recommended to read [Running cardano-node](/docs/get-started/running-cardano) guide before proceeding.
:::

### Cardano Wallets

So you installed your `cardano-node` and got it running, you probably even tried to query some simple blockchain data (If you read [Running cardano-node](/docs/getting-started/running-cardano) guide). But how do you actually create a **Cardano** wallet, receive and send some `ADA` or `tADA` tokens?
So you installed your `cardano-node` and got it running, you probably even tried to query some simple blockchain data (If you read [Running cardano-node](/docs/get-started/running-cardano) guide). But how do you actually create a **Cardano** wallet, receive and send some `ADA` or `tADA` tokens?

First we have to look at the applications we can use to create wallets.

Expand All @@ -44,7 +44,7 @@ First we have to look at the applications we can use to create wallets.

- [cardano-cli](https://github.com/input-output-hk/cardano-node) : `cardano-cli` is also a [CLI (Command Line Interface)](https://en.wikipedia.org/wiki/Command-line_interface) application that provides **Cardano** wallet functionalities. But `cardano-cli` purpose is geared more towards general **Cardano** functionalities like generating **keys**, building and submitting **transactions**, managing **stake pools** certificates, simple blockchain queries like wallet address **UTXO** and more.

It is part of the `cardano-node` project repository, so if you [compile and install](/docs/getting-started/installing-cardano-node) `cardano-node` you should also have `cardano-cli` as-well. It is one of the many Haskell-based **Cardano** software components being written by [InputOutputGlobal](https://iohk.io/).
It is part of the `cardano-node` project repository, so if you [compile and install](/docs/get-started/installing-cardano-node) `cardano-node` you should also have `cardano-cli` as-well. It is one of the many Haskell-based **Cardano** software components being written by [InputOutputGlobal](https://iohk.io/).

:::warning
Always download the wallets from official sources. There are many fake wallets, malicious software pretending to be **Cardano** wallets that could potentially steal your tokens / assets.
Expand Down Expand Up @@ -166,7 +166,7 @@ addr_test1vz95zjvtwm9u9mc83uzsfj55tzwf99fgeyt3gmwm9gdw2xgwrvsa5
- `testnet` addresses are **prefixed** with the string value `addr_test1`.


If you want to create a wallet address to be used on `mainnet`, please use the `--mainnet` flag instead of `--testnet-magic 1097911063`. You can learn more about the different **Cardano** blockchain networks [here](/docs/getting-started/running-cardano#mainnet--production).
If you want to create a wallet address to be used on `mainnet`, please use the `--mainnet` flag instead of `--testnet-magic 1097911063`. You can learn more about the different **Cardano** blockchain networks [here](/docs/get-started/running-cardano#mainnet--production).
:::

#### Querying the wallet **UTXO (Unspent Transaction Output)** with `cardano-cli`
Expand Down Expand Up @@ -486,7 +486,7 @@ Congratulations, You have created and sent your first **Cardano** transaction us
#### Creating a wallet with `cardano-wallet`

:::note
This guide assumes you have installed `cardano-wallet` into your system. If not you can refer to [Installing cardano-wallet](/docs/getting-started/installing-cardano-wallet) guide for instructions on how to do that.
This guide assumes you have installed `cardano-wallet` into your system. If not you can refer to [Installing cardano-wallet](/docs/get-started/installing-cardano-wallet) guide for instructions on how to do that.

We will use the path `/home/user/cardano/wallets` to store all the `cardano-wallet` related files as an example, please replace it with the directory you have choosen to store the files.
:::
Expand Down
Loading

0 comments on commit 7cad34c

Please sign in to comment.