Merge pull request #35 from cterrazas2/update-docs

Update install docs

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to PyVet
+
+Welcome, and thank you for wanting to contribute to `pyvet`! This is a python
+library that helps organizations, companies, and even veterans themselves
+analyze and research data from the Department of Veterans Affairs. This
+document outlines the quickest way to start contributing and get familiar
+with the code base.
+
+## Local clone and code navigation
+
+Follow the below if to contribute:
+
+1. [Installation & Environment](/docs/how-to/installation.md)
+2. [Code layout](/docs/reference/architecture.md)
+3. [Style](/docs/reference/style.md)
+4. [Tests](/docs/how-to/run_tests.md)
+
+## Features and Bugs
+
+Before you start working on a change, visit the
+[issues](https://github.com/cterrazas2/pyvet/issues) and
+[pull-requests](https://github.com/cterrazas2/pyvet/pulls) tabs and see if there
+is something already related to your change. If not, then once your change is
+completed locally, in your own branch, ensure all tests pass (and add
+tests to your change), and then create a pull request filled out with all the
+pertinent information.

docs/how-to/installation.md

@@ -1,24 +1,21 @@
 # Install
 
-## Required software
-
-* [Python](https://www.python.org/downloads/) 3.10+
-* [Poetry](https://poetry.eustace.io/docs/#installation)
-
-## Poetry
-
-PyVet uses [Poetry](https://python-poetry.org) for management of dependencies
- and virtual environments. First, use `poetry install` to install the
- dependencies, then run `poetry shell` to activate the virtual environment.
-
 ## Pip
 
-To install the `pyvet` package run the following:
+To begin using `pyvet` run the following:
 
 ```console
 pip install pyvet
 ```
 
+Check out the [Jupyter notebook](/docs/tutorials/explore_pyvet.ipynb)
+for some examples if you just want to get up and running quickly.
+
+## Required software for local development
+
+* [Python](https://www.python.org/downloads/) 3.10+
+* [Poetry](https://poetry.eustace.io/docs/#installation)
+
 ## Git
 
 Clone the `pyvet` git repo.
@@ -32,3 +29,20 @@ Or use the `gh` cli:
 ```console
 gh clone git@github.com:cterrazas2/pyvet.git
 ```
+
+## Poetry
+
+PyVet uses [Poetry](https://python-poetry.org) for management of dependencies
+and virtual environments. To install the dependencies, run
+
+```console
+poetry install
+```
+
+then
+
+```console
+poetry poetry shell
+```
+
+to activate the virtual environment.

docs/reference/architecture.md

@@ -1,12 +1,5 @@
 # PyVet Architecture
 
-`pyvet` is a python library that helps organizations, companies, and even
-veterans themselves analyze and research data from the Department of Veterans
-Affairs. This document outlines the quickest way to start contributing and
-get familiar with the code base.
-
-## Code Setup
-
 ```console
 /pyvet                            # This is where the main code lives
     /benefits                     # The VA Benefits APIs