Unstoppable Domains Documentation

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

Contributing

General rules

• Follow the Google developer documentation style guide. (Unstoppable docs style coming soon!)

• Files that shouldn't be edited directly:

  • /reference/smart-contracts/cns-smart-contracts.md
  • developer-toolkit/reference/smart-contracts/uns-smart-contracts.md
  • developer-toolkit/changelogs/*-changelog.md

Suggesting page edits

Clicking Edit at the upper right corner of any page on the documentation site will take you directly to the page in this repository.

1. Click Edit this file on the Github page to begin editing directly in your browser.

2. Make your changes. You can preview standard markdown and HTML in the Preview tab. .tsx pages and other redocly features will require setting up the Redocly development environment.

3. When you're finished with your changes, enter your commit details, create a new branch, and start a pull request.

---

Redocly development environment

To preview Redocly-specific features while editing, you will need to clone the repository and set up the Redocly Realm development environment.

Prerequisites

• node.js 20.x (specified in .nvmrc)
• nvm (recommended for managing Node versions)
• yarn

Setup

1. Use the correct Node version:

nvm use

2. Install dependencies:

yarn install

Start the development server

yarn start

The development server will run on http://localhost:4000.

Note: search isn't functional in the development environment.

Build

To build the site for production:

yarn build

Troubleshooting

If changes are not reflected in the portal, try clearing your browser cache or restart the development server.