https://github.com/unstoppabledomains/dev-docs

Unstoppable Domains Public Documentation
https://github.com/unstoppabledomains/dev-docs

docs unstoppable-domains web3 web3-domains

Last synced: about 1 month ago
JSON representation

Unstoppable Domains Public Documentation

• Host: GitHub
• URL: https://github.com/unstoppabledomains/dev-docs
• Owner: unstoppabledomains
• License: other
• Created: 2022-03-09T01:59:50.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-14T19:23:54.000Z (9 months ago)
• Last Synced: 2024-03-14T20:41:54.062Z (9 months ago)
• Topics: docs, unstoppable-domains, web3, web3-domains
• Language: MDX
• Homepage: https://docs.unstoppabledomains.com/
• Size: 75.8 MB
• Stars: 14
• Watchers: 9
• Forks: 27
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Unstoppable Domains Documentation

[![Unstoppable Domains Documentation](https://img.shields.io/badge/docs-unstoppabledomains.com-blue)](https://docs.unstoppabledomains.com/)

Unstoppable Domains Documentation is hosted by [Redocly](https://www.redocly.com/) and can be accessed at

[docs.unstoppabledomains.com](https://docs.unstoppabledomains.com/).

## Contributing

### General rules

- Follow the [Google developer documentation style guide](https://developers.google.com/style). (Unstoppable docs style *coming soon*!)

- Files that shouldn't be edited directly:

    - `developer-toolkit/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 this page** 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 page** 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. `.mdx` pages and other redocly features will require setting up the [Redocly development environment](#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 [install the Redocly developer portal](https://redocly.com/docs/developer-portal/installation/).

### Prerequisites

- [node.js >= 12.22.6 and <= 16.x](https://nodejs.org/en/)

- [yarn](https://yarnpkg.com/en/)

### Install

    yarn install

### Start the development server

    yarn start

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

### Troubleshooting

Redocly heavily relies on caching for performance issues so if some changes are not reflected in the resulting portal try cleaning cache by running:

    yarn clean