IC staking with self-custody

This is a GitHub page for creating documentation for easy self-custody staking within the Internet Computer. This is intended to be a community-driven set of documents.

You can see the GitHub page here: https://dfinity.github.io/ic-staking-documentation/

(@dprats note: the code is deployed as a github page solely to maximize public/community development + deploy. This could easily be a canister smart contract as well. That will be a good next iteration and I am working on deploying it to IC)


Relevant background and reading

Staking and NNS

Internet Computer


How to contribute

The GitHub page is composed of pages in the /docs directory. Editing the copy is just markdown.


How to run this locally

To run this locally, you should follow the instructions at .

  1. Pull down repo
  2. Setup Jekyll and other Gems necessary as denoted here Testing your GitHub Pages site locally with Jekyll
  3. Navigate to /docs
  4. Run
$ bundle exec jekyll serve

How to deploy changes

The GitHub page is tied to the branch main. Anything that is merged to main branch automatically becomes deploys to the GitHub page: https://dfinity.github.io/ic-staking-documentation/


How to edit the styling

The current theme is the "Just the Docs" Jekyll theme.

If you want to change the theme altogether, you need to do the following:

  1. Edit the _config.yml file and edit the line that reads to add whatever theme you chose.
theme: "just-the-docs"
  1. Run gem install to install the theme you chose