| title | description |
|---|---|
Listing your Project |
How you can list your TestNet project or dApp on the Moonbeam documentation site |
Disclaimer: The content in this section is entirely managed by the projects themselves. Moonbeam is a permissionless network. Any project can deploy its contracts to Moonbeam.
In general, to be considered and added to this list, your project/dApp must meet the following requirements in terms of content:
- Introduction (see template file)
- Show working contracts and/or front-ends deployed or connected to the Moonbase Alpha TestNet
- Explain to users how they can test or integrate your project/dApp
- Link the GitHub repos of the code
- Link to communication channels
This guide will help you get started on listing your project/dApp in the Moonbeam docs site.
The main idea is to fork a repository, modify it with your changes, and then submit a PR.
So, as mentioned before, first fork this repository.
Next, choose the category that relates to your project the most. There is a folder per category. If you think we are missing a category, contact us via our Discord channel, we are happy to add it to the list.
You can use the template.md file (which you can find here) as reference.
For example, let's say your project is named "Rocket Project" and related to DeFi. Then, you would need to copy this file inside the following folder:
moonbeam-project-directory
|--apis
|--assets
|--bridges
|--defi
|--|--rocket-project.md
|--explorers
...
With the file in the correct location, you can start adapting it to your specifications. Make sure to change the title, description, and first heading (all located at the top of the file). The title defines how the entry is named on the left-hand side navigation menu. The description is related to the metadata of the page:
---
title: Rocket Project (title example)
description: Rocket Project DeFi integration in Moonbase Alpha to access the Multi-Chain future and the Polkadot Ecosystem (description example)
---
# Rocket Project - DeFi Multi Chain (title example)
Images related to your documentation can be saved inside the images folder, located in the repo's main directory. Please create a folder where to save your images. For our previous example, this would be in:
moonbeam-project-directory
|--apis
...
|--defi
|--explorers
|--images
|--|--rocket-project
|--|--|--image1.png
|--|--|--image2.svg
|--marketplaces
...
Once you are done with your documentation, you can submit your pull-request from your forked repo.
Our team will check this PR to make sure it complies with the minimum requirements to be listed.