# Docs Gen for AWS Secure Environment Accelerator (ASEA)

## General Info
This project was created to auto-generate documentation of the AWS Secure Environment Accelerator (ASEA). It uses typedoc and a typescript scripts to generate the documentation. 

## Table of Contents:
* [Getting Started](#getting-Started)
* [Contributing](#contributing)

## Getting Started

## How To Install

The preferred way to generate the typedocs is to use pnpm package manager. Simply type the following into a terminal window:  
- `pnpm install -g ts-node typescript '@types/node'` - (pre-requisite) Installs ts-node
- `pnpm install` - Installs `node_modules`
- `pnpm build` - Generates typedocs in English and French and outputs the websites to `output-docs`


# Contributing
We welcome community contributions and pull requests. See [CONTRIBUTING.md](https://github.com/aws-samples/aws-secure-environment-accelerator/blob/main/CONTRIBUTING.md) for more information.