Skip to content

Commit 9503d2d

Browse files
authored
docs: improve readability
Removed redundant architecture section and consolidated module information in README.
1 parent 8ba32a8 commit 9503d2d

1 file changed

Lines changed: 10 additions & 24 deletions

File tree

README.md

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ open http://localhost:3333/api-docs
199199

200200
## 03 · Architecture
201201

202-
This API follows a **modular monolith** architecture:
202+
This API follows a **modular monolith** architecture with the following modules:
203203

204204
```
205205
┌─────────────────────────────────────────────────────────────────────────────┐
@@ -228,26 +228,6 @@ This API follows a **modular monolith** architecture:
228228
│ tournaments │ ArenaBR double-elimination tournament management │
229229
└─────────────────────┴───────────────────────────────────────────────────────┘
230230
```
231-
232-
### Architecture
233-
234-
This API follows a modular monolith architecture with the following modules:
235-
236-
- `authentication` - User authentication and authorization
237-
- `dashboard` - Dashboard statistics and metrics
238-
- `players` - Player management and statistics
239-
- `scouting` - Player scouting and talent discovery
240-
- `analytics` - Performance analytics and reporting
241-
- `matches` - Match data and statistics
242-
- `schedules` - Event and schedule management
243-
- `vod_reviews` - Video review and timestamp management
244-
- `team_goals` - Goal setting and tracking
245-
- `riot_integration` - Riot Games API integration
246-
- `competitive` - PandaScore integration, pro matches, draft analysis
247-
- `scrims` - Scrim management and opponent team tracking
248-
- `strategy` - Draft planning and tactical board system
249-
- `support` - Support ticket system with staff and FAQ management
250-
251231
### Architecture Diagram
252232

253233
```mermaid
@@ -465,7 +445,8 @@ graph TB
465445
[✓] Redis 6+
466446
```
467447

468-
### Installation
448+
<details>
449+
<summary><kbd>▶ Installation (click to expand)</kbd></summary>
469450

470451
**1. Clone the repository:**
471452
```bash
@@ -513,6 +494,8 @@ rails server
513494
```
514495

515496
> API available at `http://localhost:3333`
497+
</details>
498+
516499

517500
---
518501

@@ -1264,6 +1247,9 @@ graph TB
12641247
---
12651248

12661249
### Environment Variables
1250+
<details>
1251+
<summary><kbd>▶ Environments (click to expand)</kbd></summary>
1252+
12671253

12681254
```bash
12691255
# Core
@@ -1308,6 +1294,8 @@ BACKFILL_SYNC_LIMIT=500 # max matches synced per job run
13081294
SIDEKIQ_CONCURRENCY=10 # Sidekiq thread count (keep DB_POOL equal)
13091295
DB_POOL=10 # ActiveRecord pool size for Sidekiq container
13101296
```
1297+
</details>
1298+
13111299

13121300
### Docker
13131301

@@ -1432,8 +1420,6 @@ We follow [Ruby Style Guide](https://rubystyle.guide/) and enforce code quality
14321420
╚══════════════════════════════════════════════════════════════════════════════╝
14331421
```
14341422

1435-
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
1436-
14371423
This project is licensed under the [GNU Affero General Public License v3.0](LICENSE).
14381424

14391425
---

0 commit comments

Comments
 (0)