Skip to content

Commit

Permalink
Merge pull request #40 from w3f/autoref-plugin
Browse files Browse the repository at this point in the history
Revise structure and fix relative links
  • Loading branch information
filippoweb3 authored Jan 29, 2025
2 parents 69f5793 + 6762e9a commit 55f5c6d
Show file tree
Hide file tree
Showing 309 changed files with 2,311 additions and 1,344 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ python -m mkdocs serve

## Migration

For documentation on migration, see: [MIGRATION.MD](./MIGRATION.MD).
For documentation on migration, see: [MIGRATION.MD](MIGRATION.MD).
2 changes: 1 addition & 1 deletion docs/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
nav:
- 'Explore': explore
- 'Explore': general
- 'Learn': learn
- 'Build': build
- 'Maintain': maintain
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ SDK to communicate with the relay chain, a parachain, or any other Substrate-bas

If one aims to develop a **dApp** (Decentralized App), the Polkadot ecosystem contains various SDKs
to tap into the relay chain and parachains. There are several languages already supported -
[see the tooling page for a detailed overview of different SDKs and libraries that are available.](./build-tools-index.md)
[see the tooling page for a detailed overview of different SDKs and libraries that are available.](build-tools-index.md)

## Frameworks & Toolkits

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ communicate with Polkadot, a parachain, or any other Substrate-based chain.

If one aims to develop a **dApp** (Decentralized App), the Polkadot ecosystem contains various SDKs
to tap into the relay chain and parachains. There are several languages already supported -
[see the tooling page for a detailed overview of different SDKs and libraries that are available.](./build-tools-index.md)
[see the tooling page for a detailed overview of different SDKs and libraries that are available.](build-tools-index.md)

## Frameworks & Toolkits

Expand Down
File renamed without changes.
8 changes: 4 additions & 4 deletions docs/build/build-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ parachains and allowing all connected tasks to **interoperate** by using
[XCM](../learn/learn-xcm.md).

With the [Polkadot SDK](https://github.com/paritytech/polkadot-sdk) and
[Agile Coretime](../learn/learn-agile-coretime.md), the time it takes to develop and launch a new
[Agile Coretime](../build/cor), the time it takes to develop and launch a new
chain has dropped significantly. Depending on your goals, it may only take weeks or even days.

This starters guide will walk you through the steps you can take today to get started building your
Expand All @@ -36,7 +36,7 @@ development to user-facing applications:
!!!tip "Keep reading to find out more, or explore each respective area"
Keep in mind that these areas are merely suggestive, and there are many ways to utilize Polkadot,
Substrate, and their various developmental components. For more inspiration, look at the
[open source projects](./build-open-source.md) featured here in the wiki!
[open source projects](build-open-source.md) featured here in the wiki!

## Development Ecosystem Overview

Expand Down Expand Up @@ -99,7 +99,7 @@ developmental component can do for you within the Polkadot ecosystem.
Before diving into any one of these tracks, it is encouraged to read about Polkadot and its networks
in order to gain context about the application you could make.

[Take a look at the various development network options here.](./build-network-overview.md)
[Take a look at the various development network options here.](build-network-overview.md)

## Building Parachains

Expand Down Expand Up @@ -272,7 +272,7 @@ on-chain.

A Polkadot-native choice for smart contracts is [ink!](https://use.ink/). Other parachains that
offer EVM-based contracts written in Solidity alongside ink!
[are also available](./build-smart-contracts#parachains).
[are also available](build-smart-contracts#parachains).

Because smart contracts exist on a single chain at a time, they can have smooth interoperability
with other smart contracts on the same chain. However, they will always be constrained and limited
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ PC-->DEP
### Install dependencies

Make sure you have everything you need for your target system
[here](./build-guides-install-deps.md).
[here](build-guides-install-deps.md).

Be sure you also install the `polkadot-parachain` and `chain-spec-builder` binaries, as they needed
to start and run your chain!
Expand Down Expand Up @@ -125,4 +125,4 @@ For more information, check their

If you wish to the
[Polkadot SDK's Parachain template](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain),
please follow the [Template to Core guide.](./build-guides-template-basic.md)
please follow the [Template to Core guide.](build-guides-template-basic.md)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ We can now move on to working with the template. Essential prerequisites are:
compilation target.

!!!info "Install dependencies"
Visit [the dependencies' installation](./build-guides-install-deps.md) page before starting.
Visit [the dependencies' installation](build-guides-install-deps.md) page before starting.

This guide uses release
[`polkadot-v1.15.1`](https://github.com/paritytech/polkadot-sdk/releases/tag/polkadot-v1.15.1), for
Expand Down Expand Up @@ -171,7 +171,7 @@ The patch JSON states that:
### Generating the chain specification

> Ensure you have
> the[ `chain-spec-builder`](./build-guides-install-deps.md#install-polkadot-parachain-and-chain-spec-builder)
> the[ `chain-spec-builder`](build-guides-install-deps.md#install-polkadot-parachain-and-chain-spec-builder)
> installed before following along!
By now, you should have `patch.json` created and populated, and your `./target` folder should look
Expand Down Expand Up @@ -279,7 +279,7 @@ Within your project folder, you should now have two files:
## Running Your Collator

> Make sure you have the
> [`polkadot-parachain`](./build-guides-install-deps.md#installing-the-omninode) binary installed!
> [`polkadot-parachain`](build-guides-install-deps.md#installing-the-omninode) binary installed!
Before you are able to connect your collator, you must sync the relay chain. Depending on your
download speed, the time to sync may vary. In order to avoid storing the full state of the relay
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/build/build-network-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ within front-end contexts. You can view more on PolkadotJS and its resources
[here](https://polkadot.js.org/).

For other programmatic ways of interacting with these networks (including PolkadotJS), please view
the [Node Interactions page](./build-node-interaction.md).
the [Node Interactions page](build-node-interaction.md).

## Testnet Faucets

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ interface is broken/not compatible.
## Smart Contracts

The Polkadot relay chain does not support smart contracts, but a number of its parachains do,
[see here for more.](./build-smart-contracts.md)
[see here for more.](build-smart-contracts.md)

## Other F.A.Q.

Expand Down
File renamed without changes.
3 changes: 0 additions & 3 deletions docs/build/client-side/.pages

This file was deleted.

3 changes: 0 additions & 3 deletions docs/build/protocol-development-resources/.pages

This file was deleted.

This file was deleted.

3 changes: 0 additions & 3 deletions docs/build/tooling/.pages

This file was deleted.

Binary file removed docs/explore/.DS_Store
Binary file not shown.
10 changes: 0 additions & 10 deletions docs/explore/apps/.pages

This file was deleted.

13 changes: 0 additions & 13 deletions docs/explore/apps/index.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/explore/community-and-contributors/.pages

This file was deleted.

9 changes: 0 additions & 9 deletions docs/explore/community-and-contributors/index.md

This file was deleted.

This file was deleted.

13 changes: 0 additions & 13 deletions docs/explore/dashboards/dune-analytics/index.md

This file was deleted.

This file was deleted.

This file was deleted.

10 changes: 0 additions & 10 deletions docs/explore/dashboards/index.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/explore/funding/.pages

This file was deleted.

98 changes: 0 additions & 98 deletions docs/explore/funding/index.md

This file was deleted.

18 changes: 0 additions & 18 deletions docs/explore/index.md

This file was deleted.

10 changes: 0 additions & 10 deletions docs/explore/programs/.pages

This file was deleted.

Loading

0 comments on commit 55f5c6d

Please sign in to comment.