dappforce / subsocial-docs

Subsocial documentation.

Subsocial Docs

Prerequisites

You need to have installed:

• NodeJS >= 14.x
• Yarn

And then run:

$ yarn

This command fetches all required dependencies for this project.

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

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.

CI/CD

Good to know:

• By default, CI configured to deploy to dappforce/dappforce.github.io.
• You have to create the deployment key to be able to deploy to external repository.
• Public SSH key should be set up in the base deploy repository (in settings "Deploy keys" tab).
• Private SSH key should be set up in this exact repository (in settings "Secrets" tab).

subsocial-docs's Issues

Images not appearing

Images appear as broken icon on this page:

https://docs.subsocial.network/docs/faq/getting-started/account-setup/polkadot-js

None and Everyone Role Description must be inverted

https://docs.subsocial.network/docs/lightpaper/architecture/roles-and-permissions

On first Table, 'None' and 'Everyone' Roles have wrong Description. It should be swapped.

Create PR for Docs changes

Add:

• Starter usage commands
• GraphQL usage docs
• Redirection plugin