This repository houses documentation for the Substrate blockchain framework.
The docs are written in markdown, processed by Docusaurus, and hosted at the Substrate Developer Hub.
Thank you for your interest in contributing to the Developer Hub and to the larger Substrate community! Please review our contributor guidelines prior to any contribution. If you have any further questions, don't hesitate to reach out on our substrate technical community channel.
This repository is structured as a Docusaurus project with the markdown files organized in the /docs directory. Images
and other assets are in the /docs/assets/ directory. The /website directory is a Yarn Docusaurus project with many
helpful scripts (e.g. yarn build, yarn start) for working with this codebase. In the /website directory you will
find sidebars.json and
siteConfig.js, which are important Docusaurus files. You will find the
source code for some top-level pages in /website/pages/en. Follow our contribution guidelines.
To add a new markdown document:
- Create your markdown document in a suitable directory inside
/docs. - If you have images in your document, put them in the
/docs/assets/directory. - Documentation should follow our contribution guidelines.
- If you want your document to appear in the sidebar, add its reference in the
/website/sidebar.jsonfile under the corresponding section.
To rename an existing document:
- Change the name or path of the document.
- After the change has been merged, go to the Crowdin project, make sure the translation is already migrated to the new file automatically for all the target languages.
- Then go to Crowdin project settings, remove the
old source file in
Filestab. - If you don't have access to the Crowdin project, please send email to substrate-developer-hub@parity.io with the file information you want to remove.
cdinto the/websitedirectory.- Execute
yarn installand thenyarn start.
The Substrate Developer Hub website should open in a browser window.
Once the website is running, you should use the included Yarn script (yarn check-links) to ensure that your changes
do not introduce any broken links and to check for any links that have broken since the last time the check was
executed. Please ensure all links are fixed before submitting any changes; if you have questions about broken links that
you did not introduce, please
create an Issue.
Once you are done with your changes, feel free to submit a PR.
There is a helper script that can be used to update substrate.dev/rustdocs links in the docs/knowledgebase
directory.
# This examples demonstrates updating links from v2.0.0-rc3 to v2.0.0-rc4
OLD_VERSION=v2.0.0-rc3 NEW_VERSION=v2.0.0-rc4 ./scripts/update-kb-rustdocsOur production site is at substrate.dev. To deploy to production, merge your update into the source
branch. This triggers the CI to build the website AND also pull in multilingual translation from our Crowdin project.
The final built static site is then pushed to the master branch and hosted on GitHub Pages.
We have a staging deployment at devhub-maindocs.herokuapp.com, which is hosted on Heroku. Please check with the devhub team for the username and password to access the staging site.
To deploy to staging, you could push to the staging-source branch in the repository. This will trigger the CI to build the website, pull in multilingual translations from crowdin, and have the final built static site being pushed to staging branch. This in turn triggers Heroku to pick up the latest commit from staging branch and deploy to the staging site.
Substrate documentation is licenced under the Apache 2 license.