Skip to content

Remove files not being used in this iteration of the site, make a few… #1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 14, 2022
Merged

Remove files not being used in this iteration of the site, make a few… #1124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1296712
Remove files not being used in this iteration of the site, make a few…
lisa-parity Jun 14, 2022
ec309ff
Merge branch 'main-md' into LG/cleanup-repo-files
lisa-parity Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 10 additions & 47 deletions content/config/nav.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ tutorials:
url: /tutorials/get-started/build-local-blockchain/
- title: Simulate a network
url: /tutorials/get-started/simulate-network/
- title: Trusted node network
- title: Add trusted nodes
url: /tutorials/get-started/trusted-network/
- title: Authorize specific nodes
url: /tutorials/get-started/permissioned-network/
Expand Down Expand Up @@ -194,7 +194,7 @@ tutorials:
url: /tutorials/smart-contracts/develop-contract/
- title: Use maps for storing values
url: /tutorials/smart-contracts/use-mapping/
- title: Build a ERC20
- title: Build a token contract
url: /tutorials/smart-contracts/erc20-token/
- title: Troubleshoot smart contracts
url: /tutorials/smart-contracts/sc-common-issues/
Expand All @@ -204,8 +204,6 @@ reference:
pages:
- title: Glossary
url: /reference/glossary/
- title: Polkadot-JS
url: /reference/polkadot-js/
- title: Command-line tools
url: /reference/command-line-tools/
pages:
Expand All @@ -228,8 +226,8 @@ reference:
url: /reference/command-line-tools/subflood/
- title: subkey
url: /reference/command-line-tools/subkey/
- title: subxt-cli
url: /reference/command-line-tools/subxt-cli/
- title: subxt
url: /reference/command-line-tools/subxt/
- title: try-runtime
url: /reference/command-line-tools/try-runtime/
- title: tx-wrapper
Expand All @@ -242,52 +240,17 @@ reference:
url: /reference/frame-macros/
- title: Account data structures
url: /reference/account-data-structures/
# - title: Building block process
# url: /reference/block-building-process/
# - title: Client libraries
# url: /reference/client-lib/
- title: Type encoding (SCALE)
url: /reference/scale-codec/
- title: SS58 address format
url: /reference/ss58-format/
# - title: Transaction formats
# url: /main-docs/reference/transaction-format/
- title: Transaction formats
url: /main-docs/reference/transaction-format/
- title: Cryptography
url: /reference/cryptography/
- title: How-to reference guides
url: /reference/how-to-guides/
#pages:
#- title: Basics
#url: /reference/how-to-guides/basics/
#- title: Genesis
#url: /reference/how-to-guides/basics/genesis-config/
#- title: Chainspec
#url: /reference/how-to-guides/basics/custom-chainspec/
#- title: Storage migrations
#url: /reference/how-to-guides/basics/storage-migrations/
#- title: Constants
#url: /reference/how-to-guides/runtime-constants/
#- title: Pallet design
#url: /reference/how-to-guides/pallet-design/
#- title: Weights
#url: /reference/how-to-guides/weights/
#- title: Testing
#url: /reference/how-to-guides/testing/
#- title: Basic token mint
#url: /reference/how-to-guides/basics/mint-tokens
#- title: Consensus
#url: /reference/how-to-guides/consensus/
#- title: Parachains
#url: /reference/how-to-guides/parachains/
#- title: Tools
#url: /reference/how-to-guides/tools/
#- title: Off-chain workers
#url: /reference/how-to-guides/ocw/
# - 'Community':
# - 'community/index.md'
# - 'Writing style guidelines': 'community/style-guide.md'
# - 'Site builder guidelines': 'community/site-building.md'
#- 'How-to topic template': 'https://github.com/substrate-developer-hub/substrate-docs/blob/main/static/assets/contribute-templates/how-to-template.md/"target="_blank'
#- 'Bounties': 'community/bounty.md'
#- 'Dropbox': 'faq-dropbox/index.md'
#- 'Playground': 'https://docs.substrate.io/playground/"target="_blank'
# - 'Style guidelines': 'community/style-guide.md'
# - 'How-to template': 'https://github.com/substrate-developer-hub/substrate-docs/blob/main/static/assets/contribute-templates/how-to-template.md/"target="_blank'
#- 'Bounties': 'community/bounty.md'
#- 'Dropbox': 'faq-dropbox/index.md'
18 changes: 9 additions & 9 deletions content/md/en/docs/main-docs/build/application-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The hex blob returned by the `state_getMetadata` RPC depends on the metadata ver
In V14, this part would contain a registry of type information (generated by the `scale-info` crate).
In previous versions, this part contained the number of pallets followed by the metadata each pallet exposes.

Here is a condensed version of decoded metadata for a runtime using the V14 metadata system (generated using [`subxt-cli`](/reference/command-line-tools/subxt-cli/)):
Here is a condensed version of decoded metadata for a runtime using the V14 metadata system (generated using [`subxt`](/reference/command-line-tools/subxt/)):

```json
[
Expand Down Expand Up @@ -217,17 +217,17 @@ Parity maintains the following libraries built on top of the [JSON-RPC API](http

## Front-end use cases

| Name | Description | Language | Use case |
| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [Polkadot JS API](https://polkadot.js.org/docs/api) | A Javascript library for interacting with a Substrate chain. | Javascript | Applications that need to dynamically adapt to changes in a node, such as for block explorers or chain-agnostic interfaces. |
| [Polkadot JS extension](https://polkadot.js.org/docs/extension/) | An API for interacting with a browser extension build with the Polkadot JS API. | Javascript | Browser extensions. |
| [`Substrate Connect`](https://paritytech.github.io/substrate-connect/) | A library for developers to build applications that act as their own light client for their target chain. It also provides a browser extension designed to connect to multiple chains from a single application (web or desktop browser). | Javascript | Any browser application. |
| [`subxt`](https://github.com/paritytech/subxt/) | Short for "submit extrinsics", `subxt` is a library that generates a statically typed Rust interface to interact with a node's RPC APIs based on a target chain's metadata. | Rust | Building lower level applications, such as non-browser graphic user interfaces, chain-specific CLIs or user facing applications that require type-safe communication between the node and the generated interface, preventing users from constructing transactions with bad inputs or submitting calls that don't exist. |
| [`txwrapper`](https://github.com/paritytech/txwrapper) | A Javascript library for offline generation of Substrate transactions. | Javascript | Write scripts to generate signed transactions to a node, useful for testing and decoding transactions. |
| Name | Description | Language | Use case |
| ---- | ----------- | -------- | -------- |
| [Polkadot JS API](https://polkadot.js.org/docs/api) | A Javascript library for interacting with a Substrate chain. | Javascript | Applications that need to dynamically adapt to changes in a node, such as for block explorers or chain-agnostic interfaces. |
| [Polkadot JS extension](https://polkadot.js.org/docs/extension/) | An API for interacting with a browser extension build with the Polkadot JS API. | Javascript | Browser extensions. |
| [`Substrate Connect`](https://paritytech.github.io/substrate-connect/) | A library for developers to build applications that act as their own light client for their target chain. It also provides a browser extension designed to connect to multiple chains from a single application (web or desktop browser). | Javascript | Any browser application. |
| [`subxt`](https://github.com/paritytech/subxt/) | Short for "submit extrinsics", `subxt` is a library that generates a statically typed Rust interface to interact with a node's RPC APIs based on a target chain's metadata. | Rust | Building lower level applications, such as non-browser graphic user interfaces, chain-specific CLIs or user facing applications that require type-safe communication between the node and the generated interface, preventing users from constructing transactions with bad inputs or submitting calls that don't exist. |
| [`txwrapper`](https://github.com/paritytech/txwrapper) | A Javascript library for offline generation of Substrate transactions. | Javascript | Write scripts to generate signed transactions to a node, useful for testing and decoding transactions. |

## Where to go next

- [Substrate Connect](https://github.com/paritytech/substrate-connect)
- [Install the front-end template](/tutorials/get-started/build-local-blockchain/#install-the-front-end-template)
- [Generate a metadata QR code](https://github.com/paritytech/metadata-portal)
- [Get backwards-compatible metadata (desub)](https://github.com/paritytech/desub).
- [Get backwards-compatible metadata (desub)](https://github.com/paritytech/desub)
23 changes: 0 additions & 23 deletions content/md/en/docs/main-docs/build/best-practices.md
View file
Open in desktop

This file was deleted.

12 changes: 5 additions & 7 deletions content/md/en/docs/main-docs/build/chain-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,9 @@ After the conversion to the raw format, the `sudo key` snippet looks like this:

## Where to go next


<!-- TODO NAV.YAML -->
<!-- add these back -->
* [Add trusted validators](/tutorials/get-started/trusted-network/)
<!-- * [How-to: Genesis configuration](/reference/how-to-guides/basics/genesis-config/) -->
* [`ChainSpec` struct](https://paritytech.github.io/substrate/master/sc_service/struct.GenericChainSpec.html)
* [`ProtocolId` struct](https://paritytech.github.io/substrate/master/sc_network/config/struct.ProtocolId.html)
* [Add trusted nodes](/tutorials/get-started/trusted-network/)
* [How-to: Genesis configuration](/reference/how-to-guides/basics/genesis-config/)
* [How-to: Custom chain specification](/reference/how-to-guides/basics/genesis-config/)
* [Node template chain specification](https://github.com/substrate-developer-hub/substrate-node-template/blob/master/node/src/chain_spec.rs)
* [ChainSpec struct](https://paritytech.github.io/substrate/master/sc_service/struct.GenericChainSpec.html)
* [ProtocolId struct](https://paritytech.github.io/substrate/master/sc_network/config/struct.ProtocolId.html)
83 changes: 0 additions & 83 deletions content/md/en/docs/main-docs/build/executor.md
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion content/md/en/docs/main-docs/build/libraries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Primitive types and traits are exposed in their own separate crates, so they are
In addition to the core libraries that enable you to build a Substrate-based blockchain, there are client libraries that you can use to interact with Substrate nodes.
You can use the client libraries to build application-specific front-ends.
In general, the capabilities that the client libraries expose are implemented on top of Substrate remote procedure call (RPC) APIs.
For more information about using metadata and front-end libraries to build applications, see [Front-end development](/main-docs/build/application-dev/#rpc-apis).
For more information about using metadata and front-end libraries to build applications, see [Application development](/main-docs/build/application-dev/#rpc-apis).

## Where to go next

Expand Down
2 changes: 1 addition & 1 deletion content/md/en/docs/main-docs/build/tx-weights-fees.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Transactions, weights, and fees
description:
description: Describes how the resources required to execute transactions are accounted for through the Substrate weight system and the calculation of transaction fees.
keywords:
---

Expand Down
Loading