Add an organized documentation page
This commit is contained in:
parent
913ceb339e
commit
d919f7b972
@ -27,6 +27,6 @@ See [first steps](docs/first-steps.md).
|
|||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Most of the pages should be self explanatory to use.
|
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.
|
You can find screenshots of the application in the [bricktracker](docs/bricktracker.md) documentation file.
|
||||||
|
29
docs/DOCS.md
Normal file
29
docs/DOCS.md
Normal file
@ -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)
|
Loading…
Reference in New Issue
Block a user