Skip to content

Commit bbde935

Browse files
authored
Update README.md (#2189)
1 parent 40064a6 commit bbde935

File tree

1 file changed

+9
-106
lines changed

1 file changed

+9
-106
lines changed

README.md

+9-106
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<img alt="Substrate Logo" src="https://github.com/polkadot-developers/substrate-docs/raw/main/static/img/sub.gif" width="70%" />
44
</a>
55
</h1>
6-
<h1 align="center">Substrate Docs</h1>
7-
<h3 align="center">https://docs.substrate.io</h3>
6+
<h1 align="center">Substrate is now part of PolkadotSDK</h1>
7+
<h3 align="center">https://docs.polkadot.com/</h3>
88

99
<!-- Badges -->
1010

@@ -18,115 +18,18 @@
1818
<img style= "height: 30px" src="https://img.shields.io/static/v1?style=for-the-badge&logo=stackexchange&label=Substrate&message=Stack%20Exchange&color=green" /></a>
1919
<br>
2020
<br>
21-
<a href="https://twitter.com/intent/follow?screen_name=substrate_io">
22-
<img src="https://img.shields.io/twitter/follow/substrate_io?style=social&logo=twitter"
23-
alt="follow on Twitter"></a>
21+
<a href="https://x.com/polkadotdevs">
22+
<img src="https://img.shields.io/twitter/follow/polkadotdevs?style=social&logo=twitter"
23+
alt="follow on X"></a>
2424
</p>
2525

26-
## Contributing
26+
## docs.substrate.io -> docs.polkadot.com
2727

28-
Thank you for your interest in contributing to documentation for Substrate!
29-
As a member of the community, you are invited and encouraged to contribute by submitting issues, offering suggestions for improvements to existing content in the form of a pull request, adding review comments to existing pull requests and issues, proposing new content, or creating new pull requests to fix issues or provide new content.
28+
Thank you for your interest in the substrate documentation. As part of the new Polkadot Documentation Initiative, docs.substrate.io has been sunset, with all redirects leading to the new Polkadot Documentation found at docs.polkadot.com
3029

31-
### Working with `/docs` content
30+
## This repository has been archived
3231

33-
#### URL paths
32+
This repository has now been archived and the content frozen. If you'd like to contribute to the new Polkadot Documentation, please visit github.com/polkadot-developers/polkadot-docs to get involved. The old content will be kept for now in its markdown form for you to view if you so wish.
3433

35-
All `.md` files added to `./content/md/en/docs/` folder will output an URL path without the `/docs` prefix, eg.:
36-
37-
- `index.md` for a category page : `./content/md/en/docs/reference/index.md` &rarr; `/reference/`
38-
- `<article-name>.md` for an article in its parent category `./content/md/en/docs/reference/glossary.md` &rarr; `/reference/glossary/`
39-
40-
You can use any structure nesting needed, there is no limit of depth.
41-
42-
#### Media / Images
43-
44-
- use `./content/media/images/docs/` folder for images to be included in `/docs/*/*.md` files
45-
- source images in `.md`: `/media/images/docs/path/to/your/image/<image>.ext`
46-
47-
#### Navigation config
48-
49-
- update `./content/config/nav.yaml` to add or amend items and linking to your content
50-
- an exception being `./content/md/en/docs/reference/how-to-guides/...` files that should _only_ be listed on the main how-to guide page in the index page for these pages: `./content/md/en/docs/reference/how-to-guides/index.md`, not to be included in the sidebar.
51-
52-
This config file is used to generate sidebar menu where:
53-
54-
- menu is populated from the `menu` sequence (respecting order)
55-
- menu supports three level hierarchy
56-
- menu accepts external links, eg.: `https://substrate.io`
57-
58-
## Local Development
59-
60-
### Install
61-
62-
Navigate into your cloned local repo directory and install all dependencies.
63-
64-
```shell
65-
# https://github.com/nvm-sh/nvm is suggested, so that you
66-
# switch to the correct version of node set in the .nvmrc file
67-
nvm i
68-
69-
# Install dependencies
70-
yarn
71-
```
72-
73-
**gatsby-plugin-substrate submodule**
74-
75-
This website uses a submodule for shared components. To set it up please refer to the [gatsby-plugin-substrate repository](https://github.com/paritytech/gatsby-plugin-substrate#troubleshooting).
76-
77-
```shell
78-
git submodule update --init --recursive
79-
```
80-
81-
To update the submodule to the latest main branch, run:
82-
83-
```shell
84-
git submodule update --remote
85-
```
86-
87-
**Configure environment variables**
88-
89-
Copy `example.env.development` into a new `.env.development` file.
90-
91-
```shell
92-
cp example.env.development .env.development
93-
```
94-
95-
Config URL variables based on your preferable local setup.
96-
URL will be used for links generation between Substrate websites.
97-
98-
Default localhost port configuration:
99-
100-
```env
101-
GATSBY_WEBSITE_URL=http://localhost:8100
102-
GATSBY_DOCS_URL=http://localhost:8200
103-
```
104-
105-
**Start development server**
106-
107-
Navigate into your new site’s directory and use the following command to start the development server locally.
108-
109-
```shell
110-
yarn develop
111-
```
112-
113-
**Troubleshooting**
114-
115-
It is sometimes the case that gastby's cache gets corrupted when making changes.
116-
If you run into issues in local development, try to clean this and restart:
117-
118-
```shell
119-
yarn clean
120-
yarn develop
121-
```
122-
123-
## Security
124-
125-
Please report _security_ bugs as stated in the [`static/security.txt` file](static/security.txt) in
126-
this repository.
127-
128-
## License
129-
130-
TBD, please open an issue to request any use outside of the official host https://docs.substrate.io/ at this time.
13134

13235
<!-- Substrate **documentation** is license under the [Apache 2 license](./LICENSE). -->

0 commit comments

Comments
 (0)