Comment guidelines

Comments on our wiki should share meaningful suggestions, share insights, and improve the knowledge base of our wiki. They should be respectful, relevant, and add value to the page.

Leave Helpful Comments

• Be Constructive
  • Provide feedback that improves or clarifies content (e.g "This part could use from an example of blahblah").
  • Avoid being vague, explain why something might need changes.
• Share Knowledge
  • Add useful context, references, or alternative methods (e.g "In newer versions, you can also achieve this via blahblah").
  • Correct inaccuracies kindly with evidence or sources.
• Stay relevant
  • Comments should relate directly to the page's content.
  • For support requests, use the support channels instead.
• Keep It Respectful
  • No spam, self-promotion (even in screenshots that include your server name), or off-topic debates.
  • Assume good faith, arguments won't get anyone anywhere.

What to Avoid

• Support Requests: Comments like "This doesn’t work, please help!" will be removed.

• Advertising: Please be careful with advertising on the docs, try not to include your server's name/IP or related information in screenshots or comments.
• Private information: Do not share your email address, verkey or any other confidential information on the docs.

These guidelines are made just to give you an idea of what to do with comments, please use common sense when leaving feedback on the docs.

We may remove comments for reasons not specified here.