Wiki Contribution Guide

Prerequisites

Before contributing to the dcrdex wiki, ensure you have the following:

• A GitHub account.

• Basic knowledge of Markdown syntax.

• Markdownlint-cli2 linter installed for checking markdown files.

  You can install it via npm (install Node.js to use npm):

  npm install -g markdownlint-cli2

Steps to Contribute

1. Fork the dcrdex repo.

2. Edit files in the docs/wiki directory. Use Markdown syntax for formatting. Run the markdown linter to ensure compliance with style guidelines.

   markdownlint-cli2 -config .markdownlint.json ./docs/wiki/<Your-Edited-File>.md

   Due to the back to top feature on the doc pages, you should ignore this error:

   docs/wiki/<File-Name>.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "<a id="top"/>"]

3. Submit a PR.

Your changes will be reviewed. Updates may be requested before merging.

---

⤴ Back to Top