search

blockful-io / swaplace-contracts

Swaplace is an open-source, ownerless and feeless token swap protocol
https://app.swaplace.xyz/
MIT License
33 stars 33 forks source link

docs: generate docs using solidity-docgen and natspec #105

Closed 0xneves closed 11 months ago

0xneves commented 11 months ago

Turn the Swaplace Natspec format into documentation format as described by the following links: https://github.com/OpenZeppelin/solidity-docgen https://github.com/HQ20/soldoc

I liked the solidity-docgen more personally

dipanshuhappy commented 11 months ago

Sup @0xneves, would like to work on this task , I have some experience documenting solidity for viaprize

0xneves commented 11 months ago

Hey @dipanshuhappy, nice to see you here my friend!!

I'm assigning this task to you! Please don't hesitate to just move forward by opening PRs. I'm be online if you need anything 👍

0xneves commented 11 months ago

Awesome, I could even spot some nuances in the comments that need to be fixed ASAP! Is indeed a very practical way to quickly build the body for md files.

0xneves commented 11 months ago

closed by #109