Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into nialexsan/v3-guides-move
Browse files Browse the repository at this point in the history
nialexsan committed Nov 6, 2023
2 parents 69192e9 + 5ddeb4a commit 16c25b2
Showing 12 changed files with 4,182 additions and 3,568 deletions.
2 changes: 1 addition & 1 deletion docs/build/guides/flow-cli.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ title: Flow CLI
sidebar_label: Install Flow CLI
description: Guide to installing and using Flow CLI
sidebar_position: 2
------
---

## Installation

2 changes: 1 addition & 1 deletion docs/build/guides/fungible-token.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ title: How to Create a Fungible Token on Flow
sidebar_label: Create a Fungible Token
description: Guide to creating a fungible token on Flow with the Flow CLI and Cadence.
sidebar_position: 4
------
---

This article will guide you through the steps to create, deploy, mint, and transfer fungible tokens on Flow.

2 changes: 1 addition & 1 deletion docs/build/guides/nft.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ title: How to Create an NFT Project on Flow
sidebar_label: Create an NFT Project
description: Guide to creating an NFT Project with the Flow CLI and Cadence.
sidebar_position: 5
------
---

This tutorial dives into the technical steps required to craft an NFT on the Flow blockchain, providing developers with a clear roadmap from setup to deployment.

4 changes: 2 additions & 2 deletions docs/community-resources/projects.mdx
Original file line number Diff line number Diff line change
@@ -165,11 +165,11 @@ Explore an array of exciting, grassroots initiatives, and projects that thrive w
href: 'https://flowser.dev/',
description: 'Flowser combines all the tools for local development and gives you a clear UI to inspect the local Flow network.',
customProps: {
icon: 'https://raw.githubusercontent.com/onflowser/flowser/main/frontend/public/logo.svg',
icon: 'https://flowser.dev/icon.png',
author: {
name: 'Flowser',
profileImage:
'https://raw.githubusercontent.com/onflowser/flowser/main/frontend/public/logo.svg',
'https://flowser.dev/icon.png',
},
numStars: 0,
twitterLink: 'https://twitter.com/onflowser',
Original file line number Diff line number Diff line change
@@ -5,7 +5,7 @@ sidebar_label: Staking Collection Guide

This document outlines the steps a token holder can take to stake
using [the `FlowIDTableStaking` contract](../../core-contracts/06-staking-contract-reference.md)
and [the `FlowStakingCollection` contract.](../../core-contracts/11-staking-collection.md/)
and [the `FlowStakingCollection` contract.](../../core-contracts/11-staking-collection.md)
This is the recommended and most supported way to stake FLOW.
It supports any number of nodes and delegators per account, supports locked and unlocked FLOW,
and supports easily interaction with a node's machine account for collector and consensus nodes.
4 changes: 2 additions & 2 deletions docs/tools/flow-cli/index.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@
sidebar_position: 2
title: Flow CLI
sidebar_label: Flow CLI
------
---

## Installation

@@ -42,7 +42,7 @@ So proceed by starting the emulator:

```
> flow emulator
``
```

After creating your new project you are ready to start writing contracts. The Flow emulator is a simplified local simulation of the Flow network. Running the dev command in the CLI ensures that the contracts are deployed to the Flow emulator for you.

4 changes: 2 additions & 2 deletions docs/tools/index.mdx
Original file line number Diff line number Diff line change
@@ -16,11 +16,11 @@ import { useLocation } from '@docusaurus/router';
href: 'https://flowser.dev/',
description: 'Flowser combines all the tools for local development and gives you a clear UI to inspect the local Flow network.',
customProps: {
icon: 'https://raw.githubusercontent.com/onflowser/flowser/main/frontend/public/logo.svg',
icon: 'https://flowser.dev/icon.png',
author: {
name: 'Flowser',
profileImage:
'https://raw.githubusercontent.com/onflowser/flowser/main/frontend/public/logo.svg',
'https://flowser.dev/icon.png',
},
twitterLink: 'https://twitter.com/onflowser',
githubLink: 'https://github.com/onflowser/flowser'
5 changes: 1 addition & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -234,10 +234,7 @@ const config = {
],
],

themes: [
'mdx-v2',
hasTypesense && 'docusaurus-theme-search-typesense',
].filter(Boolean),
themes: [hasTypesense && 'docusaurus-theme-search-typesense'].filter(Boolean),

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
33 changes: 16 additions & 17 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "docusaurus",
"name": "flow-docs",
"version": "0.0.0",
"private": true,
"scripts": {
@@ -16,44 +16,43 @@
},
"dependencies": {
"@code-hike/mdx": "^0.8.2",
"@docusaurus/core": "^2.4.3",
"@docusaurus/plugin-client-redirects": "^2.4.3",
"@docusaurus/preset-classic": "^2.4.3",
"@docusaurus/types": "^2.4.3",
"@docusaurus/core": "^3.0.0",
"@docusaurus/plugin-client-redirects": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"@docusaurus/types": "^3.0.0",
"@floating-ui/react-dom": "1.3.0",
"@fortawesome/fontawesome-svg-core": "^6.4.2",
"@fortawesome/free-solid-svg-icons": "^6.4.2",
"@fortawesome/react-fontawesome": "^0.2.0",
"@headlessui/react": "1.7.13",
"@mdx-js/react": "2",
"@tailwindcss/aspect-ratio": "^0.4.2",
"@tailwindcss/forms": "^0.5.6",
"@tailwindcss/line-clamp": "^0.4.4",
"@tailwindcss/typography": "^0.5.10",
"@mdx-js/react": "^3.0.0",
"@tailwindcss/aspect-ratio": "0.4.2",
"@tailwindcss/forms": "0.5.6",
"@tailwindcss/line-clamp": "0.4.4",
"@tailwindcss/typography": "0.5.10",
"autoprefixer": "10.4.14",
"clsx": "^1.2.1",
"date-fns": "2.29.3",
"discord.js": "14.8.0",
"docusaurus-theme-mdx-v2": "^0.1.2",
"docusaurus-theme-search-typesense": "^0.12.0-0",
"docusaurus-theme-search-typesense": "^0.13.1",
"dotenv": "16.0.3",
"eslint-config-prettier": "^8.8.0",
"eslint-plugin-prettier": "^4.2.1",
"postcss": "^8.4.31",
"prettier": "^2.8.7",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"redocusaurus": "1.6.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"redocusaurus": "^1.6.4",
"rehype-katex": "4",
"remark-math": "3",
"tailwind-scrollbar-hide": "1.1.7",
"tailwindcss": "^3.3.5",
"webpack-merge": "5.8.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.4.3",
"@tsconfig/docusaurus": "^1.0.5",
"@docusaurus/module-type-aliases": "^3.0.0",
"@tsconfig/docusaurus": "^2.0.2",
"@typescript-eslint/eslint-plugin": "^5.43.0",
"eslint": "^8.0.1",
"eslint-config-standard-with-typescript": "34.0.1",
4 changes: 2 additions & 2 deletions src/theme/DocCard/index.tsx
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ import React, { type ReactNode } from 'react';
import clsx from 'clsx';
import Link from '@docusaurus/Link';
import {
findFirstCategoryLink,
findFirstSidebarItemLink,
useDocById,
} from '@docusaurus/theme-common/internal';
import isInternalUrl from '@docusaurus/isInternalUrl';
@@ -76,7 +76,7 @@ function CardCategory({
}: {
item: PropSidebarItemCategory;
}): JSX.Element | null {
const href = findFirstCategoryLink(item);
const href = findFirstSidebarItemLink(item);

// Unexpected: categories that don't have a link have been filtered upfront
if (!href) {
Original file line number Diff line number Diff line change
@@ -156,7 +156,7 @@ guards to `require` at every function entry-point, thus validating the `msg.send
[Capabilities](./language/capabilities.md) are defined by linking storage paths (namespaces for contract
storage) to protected objects and then making that linked capability available to other accounts. Public and private
scopes defined for storage paths and Capabilities themselves align precisely with
[PublicAccount](./language/accounts.mdx#publicaccount)/[AuthAccount](./language/accounts.mdx#authaccount) account scopes.
[PublicAccount](./language/accounts.mdx#publicaccount) / [AuthAccount](./language/accounts.mdx#authaccount) account scopes.

Any account can get access to an account's public Capabilities. Public capabilities are created using public paths,
i.e. they have the domain `public`. For example, all accounts have a default public capability linked to the
7,686 changes: 4,152 additions & 3,534 deletions yarn.lock

Large diffs are not rendered by default.

0 comments on commit 16c25b2

Please sign in to comment.