{"repo":"sambacha/dappspec","free":true,"listed":false,"github":"https://github.com/sambacha/dappspec","clone":"git clone https://github.com/sambacha/dappspec.git","description":"dappspec is an extended natspec and generator in one","language":"CSS","stars":10,"topics":["admonitions","devdocs","documentation","ethereum","natspec","solidity","dappspec","uerdoc","vale"],"license":null,"category":"blockchain-web3","readme_excerpt":"--- title: DAppSpec version: v2022.06.26, v2022.07.13, v2022.07.19, v2022.08.23, 2022.12.17 authors: license: CC-SA-2.5 --- dappspec tl:dr - use clear names to answer 'what' - use clear statements to answer 'how' - use comments to answer 'why' - Nikolai Mushegian Overview dappspec provides a CSS library for generating documentation from solidity natspec, you can find the preliminary library over at https://github.com/sambacha/dappspec-css This repo is a working repo for ideation and documentation. NEW: OCI for Contracts OLD: NatSpec for frontend usage + Admonitions as @custom:tags Style Guide: Flight Rules informative style guide What are \"flight rules\"? A guide for astronauts about what to do when things go wrong. Flight Rules are the hard-earned body of knowledge recorded in manuals that list, step-by-step, what to do if X occurs, and why. Essentially, they are extremely detailed, scenario-specific standard operating procedures. [...] NASA has been capturing our missteps, disasters and solutions since the early 1960s, when Mercury-era ground teams first started gathering \"lessons learned\" into a compendium that now lists thousands of problematic situations, from engine failure to busted hatch handles to computer glitches, and their solutions. — Chris Hadfield, An Astronaut's Guide to Life on Earth. Example of @custom:natspec Motivation Dappspec takes the @custom:... natspec tag and provides a list of admonitions for generating documentation for Solidity contracts. - The Spe","default_branch":null,"files":null,"tree":[],"storefront":"/r/sambacha","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/sambacha/dappspec/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}