Skip to content

Commit

Permalink
Merge pull request #724 from dfinity/add-doc-tags
Browse files Browse the repository at this point in the history
docs: Update docs to use new 'Tag' UI feature on Dev Docs.
  • Loading branch information
jessiemongeon1 authored Mar 5, 2024
2 parents 8dee95f + 2d98124 commit aabaff3
Show file tree
Hide file tree
Showing 61 changed files with 257 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Godot HTML5 sample

<MarkdownChipRow labels={["Beginner"]} />

## Overview
The example shows how to deploy a Godot HTML5 build on the IC in an asset canister. The Godot HTML5 build is deployed as frontend, no backend is needed in this sample.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Photo storage example

<MarkdownChipRow labels={["Beginner"]} />

The example shows how to store photos on the IC in an asset canister with the `@dfinity/assets` package. The photo
storage app is deployed as a frontend in an asset canister which is also used for photo upload.

Expand All @@ -16,6 +20,7 @@ This example requires an installation of:
- [x] Download and install [git](https://git-scm.com/downloads).

- [x] Download and install [Node.js](https://nodejs.org/en).

## Install

Clone the example dapp project:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Static website

<MarkdownChipRow labels={["Beginner"]} />

## Overview
The example shows how to deploy a simple, static website on the IC in an asset canister. The website is very simple, it just shows the DFINITY logo and has a basic styling of the logo.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Unity WebGL sample

<MarkdownChipRow labels={["Beginner"]} />

The example shows how to deploy a simple Unity WebGL build on the IC in an asset canister. It just shows a Unity WebGL build with the URP template installed.

The Unity WebGL build is deployed as frontend, no backend is needed in this sample.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Actor reference

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

This example demonstrates a simple use of an actor reference to convert a textual representation of some principal to a value of an actor type, that, now typed as an actor, can be communicated with by calling the shared functions of its interface.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Auth-client

<MarkdownChipRow labels={["Intermediate", "Motoko"]} />

This is an example project, intended to demonstrate how an app developer might integrate with an [Internet Identity](https://identity.ic0.app).

For a non-typescript implementation, see https://github.com/krpeacock/auth-client-demo/tree/vanilla-js
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Basic Bitcoin

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

## Deploying your first Bitcoin dapp

## Overview
Expand Down
5 changes: 5 additions & 0 deletions motoko/basic_dao/README.md → motoko/basic_dao/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Basic DAO

<MarkdownChipRow labels={["Advanced", "Motoko"]} />


This sample project demonstrates a basic [decentralized autonomous organization](https://en.wikipedia.org/wiki/Decentralized_autonomous_organization) (DAO) that can be deployed to the [Internet Computer](https://github.com/dfinity/ic). The basic DAO sample code is available in [Motoko](https://github.com/dfinity/examples/tree/master/motoko/basic_dao) and [Rust](https://github.com/dfinity/examples/tree/master/rust/basic_dao). You can see a quick introduction on [YouTube](https://youtu.be/3IcYlieA-EE).

## Overview
Expand Down
6 changes: 5 additions & 1 deletion motoko/calc/README.md → motoko/calc/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Calculator

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

![Compatibility](https://img.shields.io/badge/compatibility-0.6.25-blue)
[![Build Status](https://github.com/dfinity/examples/workflows/motoko-calc-example/badge.svg)](https://github.com/dfinity/examples/actions?query=workflow%3Amotoko-calc-example)

Expand Down Expand Up @@ -59,4 +63,4 @@ If you base your application on this example, we recommend you familiarize yours

For example, the following aspects are particularly relevant for this app:
* [Consider using stable memory, version it, test it](https://internetcomputer.org/docs/current/references/security/rust-canister-development-security-best-practices/#consider-using-stable-memory-version-it-test-it), since this canister uses canister memory, and not stable memory.
* [Validate inputs](https://internetcomputer.org/docs/current/references/security/rust-canister-development-security-best-practices/#validate-inputs), since this canister accepts user input which requires input validation (e.g. div by 0 is not allowed).
* [Validate inputs](https://internetcomputer.org/docs/current/references/security/rust-canister-development-security-best-practices/#validate-inputs), since this canister accepts user input which requires input validation (e.g. div by 0 is not allowed).
4 changes: 4 additions & 0 deletions motoko/cert-var/README.md → motoko/cert-var/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Certified variables

<MarkdownChipRow labels={["Intermediate", "Motoko"]} />

## Overview
This example demonstrates the use of a single cryptographically certified variable, as supported by the Internet Computer.

Expand Down
4 changes: 4 additions & 0 deletions motoko/classes/README.md → motoko/classes/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Classes

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

![Compatibility](https://img.shields.io/badge/compatibility-0.7.0-blue)
[![Build Status](https://github.com/dfinity/examples/workflows/motoko-classes-example/badge.svg)](https://github.com/dfinity/examples/actions?query=workflow%3Amotoko-classes-example)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Composite queries

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

This example modifies the simple actor class example to demonstrate the implementation of composite queries.
Expand Down Expand Up @@ -103,4 +107,4 @@ dfx canister call --query Map get '(15)'

## Security considerations and best practices

If you base your application on this example, we recommend you familiarize yourself with and adhere to the [security best practices](https://internetcomputer.org/docs/current/references/security/) for developing on ICP. This example may not implement all the best practices.
If you base your application on this example, we recommend you familiarize yourself with and adhere to the [security best practices](https://internetcomputer.org/docs/current/references/security/) for developing on ICP. This example may not implement all the best practices.
4 changes: 4 additions & 0 deletions motoko/counter/README.md → motoko/counter/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Counter

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

This example demonstrates a counter application. It uses an orthogonally persistent counter variable to store an arbitrary precision natural number that represents the current value of the counter.
Expand Down
4 changes: 4 additions & 0 deletions motoko/defi/README.md → motoko/defi/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Decentralized exchange sample

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

## Overview

To enable DeFi applications on the IC, canisters need to interact with token canisters and the ledger canister. This sample dapp illustrates how to facilitate these interactions. You can see a quick introduction on [YouTube](https://youtu.be/fLbaOmH24Gs).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# DIP721 NFTs

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

This example demonstrates implementing an NFT canister. NFTs (non-fungible tokens) are unique tokens with arbitrary
metadata, usually an image of some kind, to form the digital equivalent of trading cards. There are a few different
NFT standards for the Internet Computer (e.g [EXT](https://github.com/Toniq-Labs/extendable-token), [IC-NFT](https://github.com/rocklabs-io/ic-nft)), but for the purposes of this tutorial we use [DIP-721](https://github.com/Psychedelic/DIP721). You can see a quick introduction on [YouTube](https://youtu.be/1po3udDADp4).
Expand Down Expand Up @@ -439,4 +443,4 @@ For example, the following aspects are particularly relevant for this app:
## Resources
[Rust](https://rustup.rs).
[DIP721](https://github.com/Psychedelic/DIP721).
[Minting tool](https://github.com/dfinity/experimental-minting-tool).
[Minting tool](https://github.com/dfinity/experimental-minting-tool).
4 changes: 4 additions & 0 deletions motoko/echo/README.md → motoko/echo/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Echo

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

This example demonstrates a simple echo effect, where an application sends back the data it receives.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Encrypted notes: vetKD

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

This is a copy of the encrypted-notes-dapp example, adapted to (1) use [the proposed vetKD feature](https://github.com/dfinity/interface-spec/pull/158) and (2) add sharing of notes between users.

In particular, instead of creating a principal-specific AES key and syncing it across devices (by means of device-specific RSA keys), the notes are encrypted with an AES key that is derived (directly in the browser) from a note-ID-specific vetKey obtained from the backend canister (in encrypted form, using an ephemeral transport key), which itself obtains it from the vetKD system API. This way, there is no need for any device management in the dapp, plus sharing of notes becomes possible.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Encrypted notes

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

Encrypted notes is an example dapp for authoring and storing confidential information on the Internet Computer (IC) in the form of short pieces of text. Users can create and access their notes via any number of automatically synchronized devices authenticated via [Internet Identity (II)](https://wiki.internetcomputer.org/wiki/What_is_Internet_Identity). Notes are stored confidentially thanks to the end-to-end encryption performed by the dapp’s frontend.

This project serves as a simple (but not too simple) example of a dapp, which uses Motoko and Rust as backend and Svelte as frontend.
Expand Down
4 changes: 4 additions & 0 deletions motoko/factorial/README.md → motoko/factorial/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Factorial

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

This example demonstrates a recursive mathematical function that calculates the product of all positive integers less than or equal to its input.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Hello World

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

![Compatibility](https://img.shields.io/badge/compatibility-0.6.25-blue)
[![Build Status](https://github.com/dfinity/examples/workflows/motoko-hello-world--example/badge.svg)](https://github.com/dfinity/examples/actions?query=workflow%3Amotoko-hello-world-example)

Expand Down
4 changes: 4 additions & 0 deletions motoko/hello/README.md → motoko/hello/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Hello, world!

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview
This sample demonstrates a simple dapp consisting of two canisters:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Hello, cycles!

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

![Compatibility](https://img.shields.io/badge/compatibility-0.6.25-blue)

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# HTTP counter

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

The example demonstrates a counter dapp and an HTTP interface. It is essentially an iteration on the counter canister which adds native HTTP interfaces.
Expand Down
5 changes: 5 additions & 0 deletions motoko/ic-pos/README.md → motoko/ic-pos/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# IC-POS

<MarkdownChipRow labels={["Advanced", "Motoko"]} />


![](./media/header.png)


Expand Down
4 changes: 4 additions & 0 deletions motoko/icrc2-swap/README.md → motoko/icrc2-swap/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# ICRC-2 swap

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

## Overview

ICRC-2 Swap is simple canister demonstrating how to safely work with ICRC-2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Internet Identity integration

<MarkdownChipRow labels={["Intermediate", "Motoko"]} />

## Overview

This tutorial shows how to integrate Internet Identity into a dapp front-end and make use of the user identity in the backend. It builds on the "greet" dapp that is generated by running `dfx new`. If you are unfamiliar with `dfx new` and the generated application, please have a look at [this](https://internetcomputer.org/docs/current/developer-docs/setup/install/index.mdx) guide first.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Invoice canister

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

## Overview

This project provides an interface for creating invoices to process payments in either ICP or ICRC1 based tokens on the Internet Computer. It is a custodial solution, intended to provide a robust point of departure for integrating payment flow of these and other tokens in an Internet Computer canister.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# iOS integration

<MarkdownChipRow labels={["Advanced", "Motoko"]} />

## Overview
[iOS integration](https://github.com/dfinity/examples/tree/master/motoko/ios-notifications) is an experimental dapp with a native app integration that showcases a possible solution for integrating a dapp hosted in the Internet Computer with multiple platforms. For this example we've created an iOS app.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Ledger transfer

<MarkdownChipRow labels={["Intermediate", "Motoko"]} />

## Overview
ICP transfer is a canister that can transfer ICP from its account to other accounts. It is an example of a canister that uses the ledger canister. Sample code is available in [Motoko](https://github.com/dfinity/examples/tree/master/motoko/ledger-transfer) and [Rust](https://github.com/dfinity/examples/tree/master/rust/tokens_transfer).

Expand Down
4 changes: 4 additions & 0 deletions motoko/life/README.md → motoko/life/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Game of life

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

This example contains a series of implementations of Conway's Game of Life.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Minimal counter dapp

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

![Counter Frontend](README_images/frontend.png)

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Persistent storage

<MarkdownChipRow labels={["Intermediate", "Motoko"]} />

## Overview
The example dapp shows how to build a simple dapp in Motoko, which will have persistent storage. The dapp is a simple counter, which will increment a counter, retrieve the counter value and reset the counter value by calling backend functions. The functions are exposed through a Candid interface.

Expand Down
4 changes: 4 additions & 0 deletions motoko/phone-book/README.md → motoko/phone-book/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Phone book

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

![Compatibility](https://img.shields.io/badge/compatibility-0.6.25-blue)
[![Build Status](https://github.com/dfinity/examples/workflows/motoko-phone-book-example/badge.svg)](https://github.com/dfinity/examples/actions?query=workflow%3Amotoko-phone-book-example)

Expand Down
4 changes: 4 additions & 0 deletions motoko/pub-sub/README.md → motoko/pub-sub/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# PubSub

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview
This sample project demonstrates how functions may be passed as arguments of inter-canister calls to be used as callbacks.

Expand Down
4 changes: 4 additions & 0 deletions motoko/quicksort/README.md → motoko/quicksort/README.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Quicksort

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

![Compatibility](https://img.shields.io/badge/compatibility-0.6.25-blue)
[![Build Status](https://github.com/dfinity/examples/workflows/motoko-quicksort-example/badge.svg)](https://github.com/dfinity/examples/actions?query=workflow%3Amotoko-quicksort-example)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Random maze

<MarkdownChipRow labels={["Beginner", "Motoko"]} />

## Overview

The example generates a random maze using cryptographic randomness.
Expand Down
Loading

0 comments on commit aabaff3

Please sign in to comment.