Add note about OpenAPI and Redoc documentation to README
@@ -39,8 +39,11 @@ pipenv run pytest tests.py
## Documentation
After starting the server, you can view the documentation by visiting the
-root path (e.g. localhost:8090/). Alternatively, you can view the production
-version of the documentation at `https://api.creativecommons.engineering/analytics`.
+root path (e.g. localhost:8090/). You may have to tweak `docs/redoc.html` for
+this to work on your local machine.
+
+Alternatively, you can view the production version of the documentation at
+`https://api.creativecommons.engineering/analytics`.
## Contributing / Code Structure
@@ -51,9 +54,10 @@ OpenAPI documentation (`docs/swagger.yaml`) where appropriate.
and idiomatic Python. You shouldn't need to know much else besides that to get
started.
-Key technologies include:
+Key technologies to familiarize yourself with include:
* [Falcon](https://falcon.readthedocs.io/en/stable/), a backend API web framework.
* [SQLAlchemy](https://www.sqlalchemy.org/), a database ORM.
* [Alembic](https://alembic.sqlalchemy.org/en/latest/), a lightweight database migration tool for SQLAlchemy.
* [pipenv](https://docs.pipenv.org/en/latest/) for packaging.
* [Docker](https://www.docker.com/) for containerization.
+* [OpenAPI](https://www.openapis.org/) (AKA Swagger) for human and machine readable documentation.
