Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated docs directory and link to new documentation in readme. #750

Merged
merged 2 commits into from
Feb 16, 2018

Conversation

ealmansi
Copy link
Contributor

@ealmansi ealmansi commented Feb 16, 2018

Fixes #594

🚀 Description

This PR removes the deprecated docs directory and updates the link to the documentation in the readme to: https://openzeppelin.org/api/docs/open-zeppelin.html

The new documentation is generated with this project [WIP]: https://github.com/spalladino/solidity-docgen

  • 📘 I've reviewed the OpenZeppelin Contributor Guidelines
  • ✅ I've added tests where applicable to test my new functionality.
  • 📖 I've made sure that my contracts are well-documented.
  • 🎨 I've run the JS/Solidity linters and fixed any issues (npm run lint:all:fix).

@ealmansi ealmansi changed the title Feature 594 Remove deprecated docs directory and link to new documentation in readme. Feb 16, 2018
Copy link
Contributor

@facuspagnuolo facuspagnuolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@eternauta1337 eternauta1337 merged commit 108d5f3 into master Feb 16, 2018
@eternauta1337 eternauta1337 deleted the feature-594 branch February 16, 2018 18:21
ProphetDaniel pushed a commit to classicdelta/Smart-Contracts that referenced this pull request Mar 9, 2018
…dme. (OpenZeppelin#750)

* Remove deprecated docs directory.

* Update link to docs in readme.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Generate documentation site from NatSpec comments
4 participants