diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6533e3e2e..aeecef5cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,7 @@ There are many ways to contribute to the Verdaccio Project. Here’s a list of t * [Reporting a Bug](CONTRIBUTING.md#reporting-a-bug) * [Request Features](CONTRIBUTING.md#request-features) * [Plugins](CONTRIBUTING.md#plugins) +* [Improve the Documentation](wiki/README.md) Please read carefully this document. It will guide you to provide maintainers and readers valuable information to boots the process solve the issue or evaluate your proposal. diff --git a/README.md b/README.md index 9596bec68..50ebab507 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,8 @@ See in detail each of these [use cases](https://github.com/verdaccio/verdaccio/t ## Get Started +**Help? Don't miss the [documentation section](wiki/README.md)** + ### Prerequisites * Node.js >= 4.6.1 @@ -221,6 +223,7 @@ About the storage there is a running discussion [here](https://github.com/verdac If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for. +* [Documentation](wiki/README.md) * [Most common questions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion) * [Reporting a bug](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug) * [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss)