Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
anchpop committed Jul 9, 2024
1 parent fbddc06 commit f114cc2
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions example_sns_init.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@
# ------------------------------------------------------------------------------

# Name of the SNS project. This may differ from the name of the associated
# token. Must be a string of max length = 255.
# token. Must be a string of at most 255 bytes.
name: Rock Out

# Description of the SNS project.
# Must be a string of max length = 2,000.
# Must be a string of at most 2,000 bytes.
description: >
A poem co-written with ChatGPT
Expand All @@ -83,19 +83,22 @@ description: >
# cropped to a circle.
logo: logo.png

# URL to the dapp controlled by the SNS project.
# Must be a string from 10 to 512 bytes.
url: https://forum.dfinity.org/thread-where-this-sns-is-discussed
# URL that represents the SNS, usually a dapp controlled by the SNS project.
# Must be a string from 10 to 512 bytes, and the domain must be HTTPS.
url: https://mydapp.com

# Metadata for the NNS proposal required to create the SNS. This data will be
# shown only in the NNS proposal.
NnsProposal:
# The title of the NNS proposal. Must be a string of 4 to 256 bytes.
title: "NNS Proposal to create an SNS named 'Rock Out'"

# The HTTPS address of additional content required to evaluate the NNS
# The HTTPS address of a forum post with additional context required to evaluate the NNS
# proposal.
url: "https://forum.dfinity.org"
# This will go in the `url` field of the proposal.
# Must be a string of 10 to 2,048 bytes.
# The protocol must be HTTPS, and the domain must be forum.dfinity.org.
url: "https://forum.dfinity.org/thread-where-this-sns-is-discussed"

# The description of the proposal. Must be a string of 10 to 2,000 bytes.
summary: >
Expand Down

0 comments on commit f114cc2

Please sign in to comment.