Skip to content

Commit 450d7bd

Browse files
authored
Update docs (#48)
1 parent 0d93b61 commit 450d7bd

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Blog Application offers a simple, user-friendly admin panel and API for mana
1111

1212
## Key Features
1313

14-
![Creating a Post](docs/assets/resources.png)
14+
<img src="docs/assets/resources.png" alt="Key features" width="600px" />
1515

1616
- **Technologies**: Built with PHP and the [Symfony Framework](https://symfony.com), backed by a PostgreSQL database with Doctrine ORM.
1717
- **Documentation**: API documentation available via [Swagger](https://swagger.io).
@@ -28,7 +28,7 @@ The Blog Application offers a simple, user-friendly admin panel and API for mana
2828

2929
## Resources in the System
3030

31-
<img src="docs/assets/blog-menu.png" alt="Creating a Post" width="200px" />
31+
<img src="docs/assets/blog-menu.png" alt="Blog menu" width="200px" />
3232

3333
### 1. **Posts**
3434
Manage individual blog posts with titles, content, and associated categories, tags, and images.
@@ -53,7 +53,7 @@ Define and manage custom system settings to tailor the application to your needs
5353

5454
## User Roles
5555

56-
![Creating a Post](docs/assets/role-editor.gif)
56+
![Role editor](docs/assets/role-editor.gif)
5757

5858
### 1. **Admin**
5959
Admins have full access to the system:

docs/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This will set up the application and its dependencies for local development.
1515

1616
### 2. **Access the Admin Panel**
1717

18-
![Creating a Post](assets/create-admin.gif)
18+
![Creating Admin user](assets/create-admin.gif)
1919

2020
Open console in docker container:
2121
```bash
@@ -32,7 +32,7 @@ Navigate to https://localhost/admin in your browser. Use Admin e-mail and passwo
3232

3333
### 3. **Swagger API Docs**
3434

35-
![Creating a Post](assets/working-with-api.gif)
35+
![Working with api](assets/working-with-api.gif)
3636

3737
Visit https://localhost/api/doc to explore the available API endpoints.
3838

0 commit comments

Comments
 (0)