Skip to content

Commit

Permalink
docs: improve documentation for readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SverreNystad committed Jul 17, 2024
1 parent bfc51d8 commit 02aac38
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- [1. Clone the repository](#1-clone-the-repository)
- [2. Navigate to the Project Directory:](#2-navigate-to-the-project-directory)
- [Usage](#usage)
- [Documentation](#documentation)
- [Documentation 📚](#documentation-)
- [Contributors](#contributors)
- [License](#license)

Expand Down Expand Up @@ -94,14 +94,15 @@ The backend should be available at [http://localhost:8080/](http://localhost:808

For the full development setup, see the [Developer Setup](docs/manuals/developer_setup.md) guide.

## Documentation
- [Developer Setup](docs/manuals/developer_setup.md)
- [Testing](docs/manuals/testing.md)
- [API Documentation](docs/manuals/api_documentation.md)
## Documentation 📚
- [Developer Setup](docs/manuals/developer_setup.md) 🛠️
- [Testing](docs/manuals/testing.md) 🧪
- [API Documentation](docs/manuals/api_documentation.md) 📖
- [Docker Guide](docs/docker.md) 🐳
- [Understanding the Minimax Algorithm](docs/minimax.md) 🧠
- [Architecture](docs/architecture.md) 🏗️


![Alt text](docs/images/backend.png)

## Contributors
<table align="center">
<tr>
Expand Down
3 changes: 3 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Architecture

![Alt text](images/backend.png)

0 comments on commit 02aac38

Please sign in to comment.