Skip to content

Commit

Permalink
update: Sidebars and remove all "overview" titles (#3884)
Browse files Browse the repository at this point in the history
* Remove overview in page titles and sidebar

* styleguide

* styleguide

* update link

* Update README.md
  • Loading branch information
jessiemongeon1 authored Dec 17, 2024
1 parent 8be2c35 commit 650da62
Show file tree
Hide file tree
Showing 41 changed files with 167 additions and 211 deletions.
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,6 @@ This audience should be kept in mind when writing docs. For example:
### Documentation types
The structure and content of the documentation page will vary based on the document type. Some common types are:

#### Overview
An overview of a documentation section or broad concept of ICP. When creating an overview page that discusses the capabilities of ICP, the benefits and attributes of the possible capabilities should be written about, not only the currently implemented workflows. For example, instead of writing about the currently implemented Bitcoin and Ethereum integrations, the [Chain Fusion overview](/docs/current/developer-docs/multi-chain/overview) page discusses ICP’s cross-chain functionalities and benefits on a much broader scale beyond the two current integrations.

For overview pages, using bullet point lists to describe specific benefits or features of ICP is recommended.

#### Feature or tool detail page
A page that details a specific tool or feature. Feature or tool pages should provide a deeper explanation of a specific feature or tool, why a developer should use it, and how they can use it. It should describe the currently implemented workflows the feature/tool supports, and should not include details of conceptual ideas that are not currently live for developers to use (future roadmap items, possible improvements in the future, etc.)

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/daos/sns/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [advanced, governance, concept, sns, introduction]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# SNS overview
# What is an SNS?

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

Expand Down
2 changes: 0 additions & 2 deletions docs/developer-docs/daos/sns/tokenomics/rewards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ Each SNS can be individually configured with parameters that define, among other
how an SNS uses rewards to incentivize certain behavior for the governance participants
and the dapp users.

## Rewards Overview

The goal of this article is to explain the design of the SNS reward scheme.

The full potential of tokenization can be unlocked by a tokenized open governance system,
Expand Down
3 changes: 1 addition & 2 deletions docs/developer-docs/daos/sns/tokenomics/tokenomics-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ Therefore when launching or maintaining an SNS, it is important to understand to
The described concepts are also relevant for
[other DAOs](../overview#dao-alternatives).

## Tokenomics overview
### What is tokenomics?
## What is tokenomics?
A token is a digital asset on a blockchain. Tokenomics describes the economics of a token system on a blockchain. It is a game changer for decentralized autonomous organization (DAOs) compared to traditional apps running on a Web 2.0 infrastructure, because it enables the introduction of new incentive systems and use cases. Tokenizing a DAO allows, for instance, that anyone in the world can purchase tokens and thereby contribute to initial funding for the DAO. Moreover, tokens can be paid to early adopters and active users, which will help attract users.

Tokenomics covers a wide range of topics, such as
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/defi/dex/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [intermediate, defi, overview, dex, decentralized exchange, exchange]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Decentralized exchange overview
# Decentralized exchanges

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/defi/nfts/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [intermediate, concept, nfts]
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

# NFT overview
# NFTs

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/defi/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [intermediate, defi, overview, tokens, icrc-1, icrc ledger, icrc index
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

# Digital assets overview
# Digital assets

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/defi/rosetta/icp_rosetta/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [intermediate, rosetta, tutorial, approve, icrc, rosetta]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Overview
# What is ICP Rosetta?

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

Expand Down
3 changes: 2 additions & 1 deletion docs/developer-docs/defi/rosetta/icrc_rosetta/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ keywords: [intermediate, rosetta, tutorial]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Overview
# What is ICRC Rosetta?

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

The ICRC Rosetta implementation allows for communication with the ICRC-1 compatible ledgers through the [Rosetta-API standard](https://docs.cdp.coinbase.com/mesh/docs/welcome). Examples include the [ckBTC ledger](https://dashboard.internetcomputer.org/canister/mxzaz-hqaaa-aaaar-qaada-cai) and the [ckETH ledger](https://dashboard.internetcomputer.org/canister/ss2fx-dyaaa-aaaar-qacoq-cai).
Expand Down
3 changes: 1 addition & 2 deletions docs/developer-docs/defi/token_integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

Developers have several options for integrating with the ICP or ICRC-1 ledgers. They can use either the ICRC Rosetta or ICP Rosetta implementations, which is commonly recommended, it might be useful for certain workflows to directly integrate with these ledgers. This section will describe what a direct integration means, how it can be achieved, and how it differs to using Rosetta.

## Token architecture overview

## Token architecture

Tokens on ICP are managed by smart contracts. The ICP ledger canister manages the list of balances for ICP tokens and implements methods for transferring tokens. It builds a chain of blocks consisting of all ICP token transactions since genesis. The chain is authenticated by having the ICP sign the tip of the chain. External parties can retrieve this chain and verify it is genuine by:
- Verifying the signature which requires the public key of ICP.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

Developers have several options for integrating with the ICP or ICRC-1 ledgers. They can use either the ICP or ICRC Rosetta implementations, which is commonly recommended, although for some workflows, it might be beneficial to directly integrate with these ledgers instead. This section will describe what a direct integration means, how it can be achieved, and how it differs to using Rosetta.

## Token architecture overview

## Token architecture

Tokens on ICP are managed by smart contracts. The ICP ledger canister manages the list of balances for ICP tokens and implements methods for transferring tokens. It builds a chain of blocks consisting of all ICP token transactions since genesis. The chain is authenticated by having the ICP sign the tip of the chain. External parties can retrieve this chain and verify it is genuine by:
- Verifying the signature using the public key of ICP.
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/defi/wallets/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [beginner, concept, asset custody, self-custody]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Wallet overview
# Wallets

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

Expand Down
4 changes: 1 addition & 3 deletions docs/developer-docs/developer-tools/dev-tools-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ keywords: [beginner, developer tools, dev tools, overview]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Developer tool overview
# Developer tooling

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



Developer tools are used to create, manage, and interact with canisters. They can come in several formats, such as command line tools, onchain and off-chain libraries, and integrated development environments. For ICP developers, there are tools within each of these categories available for you to utilize when developing your ICP canisters.

## Command line
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [intermediate, agents, overview, javascript, rust, nodejs]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Agents overview
# What are the ICP agents?

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/identity/authentication/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [authentication, identity, login, user login, integration]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Authentication overview
# Integrating authentication into an application

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [intermediate, concept, user sign in, user login, internet identity]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Internet Identity overview
# What is Internet Identity?

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [intermediate, concept, identity, credentials, verifiable credentials]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Verifiable credentials overview
# What are verifiable credentials?

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/multi-chain/bitcoin/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [advanced, bitcoin, btc, overview]
import useBaseUrl from "@docusaurus/useBaseUrl";
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Bitcoin integration overview
# Bitcoin integration

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [advanced, bitcoin, btc, ckbtc, chain-key bitcoin]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# ckBTC overview
# ckBTC

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [advanced, ethereum, cketh, erc20, ckerc20, ckusdc, cklink, ckoct, ckp
import useBaseUrl from "@docusaurus/useBaseUrl";
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# ckERC20 overview
# ckERC20

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [advanced, ethereum, cketh, chain-key ethereum, overview]
import useBaseUrl from "@docusaurus/useBaseUrl";
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# ckETH overview
# ckETH

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [advanced, Chain Fusion, overview, chain-key tokens, cktokens, ck toke
import useBaseUrl from "@docusaurus/useBaseUrl";
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Chain-key token overview
# Chain-key tokens

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

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-docs/multi-chain/ethereum/evm-rpc/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ keywords: [advanced, ethereum, evm rpc, evm, tutorial]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# EVM RPC canister overview
# EVM RPC canister

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

**EVM RPC** is an ICP canister smart contract for communicating with [Ethereum](https://ethereum.org/en/) and other [EVM blockchains](https://chainlist.org/?testnets=true) using an onchain API. Communication with EVM-compatible chains includes obtaining and sending information such as:
The **EVM RPC** canister is used for communicating with [Ethereum](https://ethereum.org/en/) and other [EVM blockchains](https://chainlist.org/?testnets=true) using an onchain API. Communication with EVM-compatible chains includes obtaining and sending information such as:

- The logs of a specific block or transaction.

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/multi-chain/ethereum/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [advanced, ethereum, overview]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Ethereum integration overview
# Ethereum & EVM integration

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/multi-chain/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
import { AdornedTabs } from "/src/components/Tabs/AdornedTabs";
import { AdornedTab } from "/src/components/Tabs/AdornedTab";

# Chain Fusion overview
# What is Chain Fusion?

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [security, concept]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Overview
# What are security best practices?

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ keywords: [https outcalls, advanced, concept]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# HTTPS outcalls overview
# What are HTTPS outcalls?

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

Canister smart contracts can make a request to a URL using [HTTPS outcalls](https://internetcomputer.org/https-outcalls). HTTPS outcalls can be used to directly obtain off-chain data or interact with off-chain systems, such as Web 2.0 services or enterprise IT infrastructure.
Canisterscan make a request to a URL using [HTTPS outcalls](https://internetcomputer.org/https-outcalls). HTTPS outcalls can be used to directly obtain off-chain data or interact with off-chain systems, such as Web 2.0 services or enterprise IT infrastructure.

HTTPS outcalls enable a wide range of applications. For example, oracle services can directly integrate with ICP in a trustless manner, and dapps can provide user notifications or anything else that requires communication with servers on the Internet.

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/smart-contracts/call/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { BetaChip } from "/src/components/Chip/BetaChip";
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

# Call overview
# Calling canisters

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/smart-contracts/deploy/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { BetaChip } from "/src/components/Chip/BetaChip";
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

# Deploy overview
# Deploying canisters

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer-docs/smart-contracts/encryption/vetkeys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [advanced, concept, vetkd, vetkeys]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Overview
# What are vetKeys?

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

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-docs/smart-contracts/test/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ keywords: [intermediate, test, tutorial, test code, test canister, pocket ic, po
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

# Testing canisters overview
# Testing canisters

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

Testing your canister's code during the development process is an important step to verify that the code operates as expected and does not produce bugs, errors, or result in the canister trapping. Before deploying and using the code in a production environment, it should undergo testing.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [beginner, concept, frontend, asset canister, assets]
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

# Asset canister overview
# What is an asset canister?

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

Expand Down
2 changes: 0 additions & 2 deletions docs/references/asset-canister.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

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

## Overview

An [asset canister](https://github.com/dfinity/sdk/tree/master/src/canisters/frontend/ic-frontend-canister), also referred to as a 'frontend canister' is a type of canister deployed on ICP that can be used to store and retrieve an application's frontend, typically used to serve static HTML, JS, and CSS assets.

## Architecture reference
Expand Down
2 changes: 0 additions & 2 deletions docs/references/bitcoin-how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

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

## Overview

The Bitcoin integration on the Internet Computer allows for direct and trustless interaction with the Bitcoin network, enabling canister smart contracts to create Bitcoin addresses and send and receive bitcoin directly. This opens up new possibilities for decentralized applications and services, such as DeFi, that can leverage the liquidity and security of Bitcoin without relying on centralized bridges, thereby enhancing security and efficiency.

Two advanced engineering challenges needed to be solved to enable Bitcoin smart contracts on ICP:
Expand Down
2 changes: 0 additions & 2 deletions docs/references/candid-ref.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

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

## Overview

This document provides detailed reference information about Candid supported types and links to the Candid specification and documentation for the Candid Rust crate.

- [Supported types](#supported-types).
Expand Down
2 changes: 1 addition & 1 deletion docs/references/dashboard/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords: [ICP dashboard, dashboard, icp dashboard]
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";
import { GlossaryTooltip } from "/src/components/Tooltip/GlossaryTooltip";

# ICP dashboard overview
# Using the ICP dashboard

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

Expand Down
1 change: 0 additions & 1 deletion docs/references/execution-errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

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

## Overview
A list of possible errors returned when executing canisters.

## Errors
Expand Down
2 changes: 0 additions & 2 deletions docs/references/https-outcalls-how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

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

## Overview

This page provides details on how canister HTTPS outcalls, or canister HTTP requests, work and important aspects to consider when using the API. You also want to note that there are some limitations and differences compared to regular (Web 2.0) computer programs making HTTP calls and considerations for programmers for successfully using this feature. Engineers who intend to use this feature are advised to read through this page to get up to speed quickly w.r.t. the feature. The impatient reader who wants to dive into coding right away can skip the conceptual part and jump right away to the [coding section](#coding-https-outcalls) to get started.

## Architecture
Expand Down
2 changes: 1 addition & 1 deletion docs/references/node-providers/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ keywords: [references, node providers, nodes ]

import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# Node provider overview
# Node provider resources

<MarkdownChipRow labels={["Reference", "Node providers"]} />

Expand Down
Loading

0 comments on commit 650da62

Please sign in to comment.