Skip to content

Commit fd6ff95

Browse files
authored
Update links to explicit paths (polkadot-js#17)
* Update links to explicit paths * Update README
1 parent b223da1 commit fd6ff95

File tree

9 files changed

+17
-37
lines changed

9 files changed

+17
-37
lines changed

README.md

+4-28
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,9 @@
1-
# Website
1+
# polkadot-js docs
22

3-
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
3+
This is a documentation portal for the `@polkadot` family of tools and libraries. The latest version is always available at [https://polkadot.js.org/docs/](https://polkadot.js.org/docs/)
44

5-
## Installation
65

7-
```console
8-
yarn install
9-
```
6+
## Help us help others
107

11-
## Local Development
8+
If you spot gaps in the information provided, or are uncertain about any specific area, please do [log an issue](https://github.com/polkadot-js/docs/issues) or if you are that way inclined, make a pull-request. We really want to have good documentation in these areas and allow people to be productive right from the start.
129

13-
```console
14-
yarn start
15-
```
16-
17-
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
## Build
20-
21-
```console
22-
yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
## Deployment
28-
29-
```console
30-
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
31-
```
32-
33-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/api/FAQ.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
id: FAQ
32
title: FAQ
43
---
54

docs/api/cookbook/intro.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Overview
3+
slug: /api/cookbook
34
---
45

56
The cookbook hosts small code snippets in a question-answer format. It does not walk you through the whole setup, like the [basic examples](../examples/promise), but rather aims to answer some questions around specific uses. It also does not replace the [FAQ](../FAQ.md), rather this is focussed explicitly on code samples, instead of general trouble-shooting for common mishaps.

docs/api/intro.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ slug: /api
55

66
The API provides application developers the ability to query a node and interact with the Polkadot or Substrate chains using Javascript. Here you will find documentation and examples to get you started.
77

8-
[Jump right in](start/) and get an overview on using the API in your projects, from installation all the way through to making it do magic. Have things working and want tips? The [cookbook](cookbook/) provides some tips and tricks. Getting started and want some full examples? [The ApiPromise examples](examples/promise/) provide some basic examples.
8+
[Jump right in](start/intro.md) and get an overview on using the API in your projects, from installation all the way through to making it do magic. Have things working and want tips? The [cookbook](cookbook/intro.md) provides some tips and tricks. Getting started and want some full examples? [The ApiPromise examples](examples/promise/intro.md) provide some basic examples.
99

10-
For oft-repeated questions, the [FAQ](FAQ) may have what you are looking for.
10+
For oft-repeated questions, the [FAQ](FAQ.md) may have what you are looking for.
1111

12-
Separated from the API you will also find the [Substrate metadata](../substrate) section that has an overview of the RPC, extrinsics, events and errors available on a typical Substrate node.
12+
Separated from the API you will also find the [Substrate metadata](../substrate/intro.md) section that has an overview of the RPC, extrinsics, events and errors available on a typical Substrate node.

docs/api/start/intro.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Overview
3+
slug: /api/start
34
---
45

56
These sections should provide you with all the information needed to install the `@polkadot/api` package, understand the structure of the interfaces and allow you to start using it. For existing users this really should be titled "Things I wish I knew before I started using the api" - it really aims to close the gap to allow anybody to get to grips with using the packages.

docs/keyring/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ slug: /keyring
55

66
The Keyring allows you to manage a set of keys in a consistent environment, allows you to perform operations on these keys (such as sign/verify) and never exposes the secretKey to the outside world.
77

8-
For oft-repeated questions, the [FAQ](FAQ) may have what you are looking for.
8+
For oft-repeated questions, the [FAQ](FAQ.md) may have what you are looking for.

docs/util-crypto/FAQ.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
id: FAQ
32
title: FAQ
43
---
54

docs/util-crypto/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: Overview
33
slug: /util-crypto
44
---
55

6-
For oft-repeated questions, the [FAQ](FAQ) may have what you are looking for.
6+
For oft-repeated questions, the [FAQ](FAQ.md) may have what you are looking for.

src/css/custom.css

+6-2
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,17 @@
2020
--ifm-toc-border-color: transparent;
2121
}
2222

23+
h1 {
24+
font-size: var(--ifm-h1-font-size) !important;
25+
}
26+
2327
.docusaurus-highlight-code-line {
2428
background-color: rgb(72, 77, 91);
2529
display: block;
2630
margin: 0 calc(-1 * var(--ifm-pre-padding));
2731
padding: 0 var(--ifm-pre-padding);
2832
}
2933

30-
h1 {
31-
font-size: var(--ifm-h1-font-size) !important;
34+
.menu__link {
35+
outline: none !important;
3236
}

0 commit comments

Comments
 (0)