Unstoppable Domains Documentation

Unstoppable Domains Documentation

Unstoppable Domains Documentation is hosted by GitBook and can be accessed at docs.unstoppabledomains.com.

Contributing

General rules:

Working with templates and auto-generated pieces:

Files that shouldn't be edited directly (follow described flow instead):
  • src/domain-registry-essentials/cns-smart-contracts.md:

    1. Edit templates/cns-smart-contracts-template.md;
    2. Run render:cns-contracts.
  • src/domain-registry-essentials/uns-smart-contracts.md:

    1. Edit templates/uns-smart-contracts-template.md;
    2. Run render:uns-contracts.
Auto-generated smart-contract address tables:

Contract addresses are pulled from:

  • network-config.json contained in dot-crypto for CNS contracts

  • uns-config.json contained in uns for UNS contracts

  • To fetch new config for existing contracts run render:cns-contracts or render:uns-contracts.

  • If you need to add a new contract:

    1. Inside of the template insert #include "templates/contracts/<YourContractName>.md" where you want to add your table;
    2. Generate tables & compile the template using:
      • render:cns-contracts to render src/domain-registry-essentials/cns-smart-contracts.md.
      • render:uns-contracts to render src/domain-registry-essentials/uns-smart-contracts.md.

Tips for external contributors:

In order to preview a fork branch of the documentation, you can create a private GitBook space and link your fork when setting up GitHub integration.

Tips for Unstoppable team:

Branch previews are available at the development GitBook space.