Updated guides for deployment, setup and contributing

Author: n7studios

DEPLOYMENT.md

@@ -14,11 +14,22 @@ We follow [Semantic Versioning](https://semver.org/).
 
 - In `src/ConvertKit_API.php`, change the `const VERSION` to the new version number.
 
+## Run phpDocumentor
+
+We use [phpDocumentor](https://www.phpdoc.org/) to automatically generate the [PHP SDK documentation](./docs/classes/ConvertKit_API/ConvertKit_API.md).
+
+In a Terminal window, run the phpDocumentor command to generate documentation in markdown format:
+
+```bash
+phpDocumentor --directory=src --target=docs --template="vendor/saggre/phpdocumentor-markdown/themes/markdown"
+```
+
 ## Commit Changes
 
 Commit the updated files, which should comprise of:
 
 - `src/ConvertKit_API.php`
+- `docs/classes/ConvertKit_API/ConvertKit_API.md`
 
 ## Create a New Release
 

README.md

@@ -81,4 +81,10 @@ try {
 
 ## Documentation
 
-See the [PHP SDK docs](./docs/classes/ConvertKit_API/ConvertKit_API.md) 
+See the [PHP SDK docs](./docs/classes/ConvertKit_API/ConvertKit_API.md)
+
+## Contributing
+
+See our [contributor guide](CONTRIBUTING.md) for setting up your development environment, testing and submitting a PR.
+
+For ConvertKit, refer to the [deployment guide](DEPLOYMENT.md) on how to publish a new release.

SETUP.md

@@ -79,7 +79,7 @@ parameters:
 
 ### Install Packages
 
-In the Plugin's directory, at the command line, run `composer install`.
+In the root directory, at the command line, run `composer install`.
 
 This will install two types of packages:
 - Packages used by the SDK (e.g. Guzzle and Monolog)
@@ -88,9 +88,17 @@ This will install two types of packages:
 -- PHPUnit
 -- PHP_CodeSniffer
 
-How to use these is covered later on, and in the [Testing Guide](TESTING.md)
+### Install phpDocumentor
 
-### Running the Test Suite
+Download the latest phpDocumentor release.
+
+On Mac / Linux, mark it as executable and move it to your bin folder, so it can be run globally:
+```bash
+chmod +x phpDocumentor.phar
+mv phpDocumentor.phar /usr/local/bin/phpDocumentor
+```
+
+### Running PHPUnit Tests
 
 In a Terminal window, run the tests to make sure there are no errors and that you have 
 correctly setup your environment:
@@ -106,7 +114,7 @@ your environment is setup successfully.
 
 ### Running CodeSniffer
 
-In the Plugin's directory, run the following commands to run PHP_CodeSniffer, which will check the code meets PHP Coding Standards:
+In the root directory, run the following commands to run PHP_CodeSniffer, which will check the code meets PHP Coding Standards:
 
 ```bash
 vendor/bin/phpcs