You can find a new repository by the following link: https://github.com/unstoppabledomains/live-docs
Legacy README
Unstoppable Domains Documentation is hosted by GitBook and can be accessed at docs.unstoppabledomains.com.
The live version of the documentation is synced with live-docs repository.
General rules:
- Try to follow Google developer documentation style guide.
Working with templates and auto-generated pieces:
- src/domain-registry-essentials/cns-smart-contracts.md:
- Edit templates/cns-smart-contracts-template.md;
- Run
render:cns-contracts
.
Contract addresses are pulled from network-config.json contained in dot-crypto.
- To fetch new config for existing contracts run
render:cns-contracts
. - If you need to add a new contract:
- Inside of the template insert
#include "templates/contracts/<YourContractName>.md"
where you want to add your table; - Generate tables & compile the template using:
render:cns-contracts
to render src/domain-registry-essentials/cns-smart-contracts.md.
- Inside of the template insert
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.