diff options
| author | F. Eugene Aumson <gene@aumson.org> | 2018-09-22 23:06:48 +0800 |
|---|---|---|
| committer | F. Eugene Aumson <gene@aumson.org> | 2018-09-22 23:29:27 +0800 |
| commit | 98d06d6d252ed379d60bcef915caf38a5ec7a5af (patch) | |
| tree | b68eac94243885495d06e67e70ad8b12a635a517 /packages/react-docs/README.md | |
| parent | 9f0dfb1e1a4c97e462cf298e0452be1d0fcf2216 (diff) | |
| download | dexon-0x-contracts-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.gz dexon-0x-contracts-98d06d6d252ed379d60bcef915caf38a5ec7a5af.tar.zst dexon-0x-contracts-98d06d6d252ed379d60bcef915caf38a5ec7a5af.zip | |
BREAKING CHANGE: document contracts from sol-doc
Change website to accept smart contract documentation in the format
generated by sol-doc rather than that generated by Doxity.
Diffstat (limited to 'packages/react-docs/README.md')
| -rw-r--r-- | packages/react-docs/README.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md index 5d56207de..51e949967 100644 --- a/packages/react-docs/README.md +++ b/packages/react-docs/README.md @@ -2,7 +2,7 @@ #### WARNING: Alpha software. Expect things to break when trying to use. -A full-page React component for rendering beautiful documentation for Solidity and Typescript code generated with [TypeDoc](http://typedoc.org/) or [Doxity](https://github.com/0xproject/doxity). +A full-page React component for rendering beautiful documentation for Solidity and Typescript code generated with [TypeDoc](http://typedoc.org/) or [sol-doc](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-doc). <div style="text-align: center;"> <img src="https://s3.eu-west-2.amazonaws.com/0x-wiki-images/screenshot.png" style="padding-bottom: 20px; padding-top: 20px;" width="80%" /> @@ -47,7 +47,7 @@ Feel free to contribute to these improvements! * Allow user to pass in styling for all major elements similar to [Material-UI](http://www.material-ui.com/). * Allow user to define an alternative font and have it change everywhere. -* Add source links to Solidity docs (currently unsupported by Doxity). +* Add source links to Solidity docs (currently unsupported by solc, which underlies sol-doc). ## Contributing |