Documentation Structure

[kkuzemka]

Documentation Structure

The Federated Gateway service needs documentation written within the repository. We want to keep docs close to the code to reduces friction for developers trying to keep them up to date. Please follow the authorization docs structure for the first pass at docs, we can expand from there if needed. The real point of this issue is to get the documentation structure started and we'll fill it in as we work on the service.

User Stories

• As a developer/product manager I want to read a quick tech and marketing breakdown of the service.
• As a developer I want to read documentation about this service.

Deliverable

• Updated README with ELI5 description, tech features and biz benefits.
• A docs directory with a README for a Table of Contents.
• Create markdown files for Quick Start, Concepts, Configuration, Specification, API, Testing and Deployment.

Acceptance Criteria

• Updated README for project.
• docs directory with Table of Contents README.
• All base documentation files created with titles.

[kkuzemka]

Please see - https://github.com/reactioncommerce/categories/tree/trunk/docs for reference.