Skip to content

[Docs] Create "How to Document Your Contract" Guide #5

@mijinummi

Description

@mijinummi

Title: [Docs] Create "How to Document Your Contract" Guide

📝 Description

We need to help developers understand how to make the most of SpecDoc. This guide will explain how to prepare their contracts for the best documentation experience.

🎯 Goal

Write a docs/best-practices.md file that explains how to use NatSpec (Solidity) or Doc-comments (Rust) to improve the generated output.

✅ Requirements

  • Explain how SpecDoc pulls "Description" text from code comments.
  • Provide a "Before vs. After" example of a well-documented contract.
  • List supported wallet integrations (Freighter, MetaMask).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationdrips-wave-1Extra attention is neededgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions