diff --git a/README.md b/README.md index 5b24ce5..592e39e 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,6 @@ See [first steps](docs/first-steps.md). ## Documentation Most of the pages should be self explanatory to use. -However, you can find more specific documentation in the [docs](docs/) folder. +However, you can find more specific documentation in the [documentation](docs/DOCS.md). You can find screenshots of the application in the [bricktracker](docs/bricktracker.md) documentation file. diff --git a/docs/DOCS.md b/docs/DOCS.md new file mode 100644 index 0000000..0f64f3a --- /dev/null +++ b/docs/DOCS.md @@ -0,0 +1,29 @@ +# Bricktracker documentation + +This page helps you navigate the documentation of BrickTracker. + +## Overview + +- [Overview](overview.md) (this screenshots of the application are here!) + +## Installation + +- [Setup](setup.md) + +## Usage + +- [First steps](first-steps.md) +- [Managing your sets](set.md) + +## Specific procedures + +- [Setup basic authentication](authentication.md) +- [Move an existing ./app.db database](move-existing-database.md) + +## Troubleshooting + +- [Common errors](common-errors.md) + +## Development + +- [Development](development.md) \ No newline at end of file