Skip to content

Commit f91eb91

Browse files
author
Julien Neuhart
committed
Reorganize documentation
1 parent f8411c2 commit f91eb91

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+1901
-2108
lines changed
File renamed without changes.

docs/docs/2_Development Environment/2_1_Docker Compose.md renamed to docs/docs/02_Development Environment/1_Docker Compose.md

File renamed without changes.
File renamed without changes.

docs/docs/2_Development Environment/2_3_Housekeeping.md renamed to docs/docs/02_Development Environment/3_Housekeeping.md

File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Overview
3-
slug: /api/overview
3+
slug: /api
44
---
55

66
We built the API with [Symfony 5](https://symfony.com/), [TDBM](https://github.com/thecodingmachine/tdbm), and
Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Configuration
33
slug: /api/configuration
44
---
55

6-
General documentation on how to configure Symfony. More details are available in the [Guides](../guides/i18n) section
7-
or in the [official documentation](https://symfony.com/doc/current/configuration.html).
6+
General documentation on how to configure Symfony. More details are available
7+
in the [official documentation](https://symfony.com/doc/current/configuration.html).
88

99
## Symfony
1010

@@ -69,28 +69,4 @@ public function __construct(
6969
) {
7070
$this->foo = $parameters->get('app.foo');
7171
}
72-
```
73-
74-
## Composer
75-
76-
:::note
77-
78-
📣  All commands have to be run in the `api` service (`make api`).
79-
80-
:::
81-
82-
When installing a PHP dependency, ask yourself if it is a `dev` dependency or not:
83-
84-
```
85-
composer require [--dev] [package]
86-
COMPOSER_MEMORY_LIMIT=-1 composer normalize
87-
```
88-
89-
As we're using Symfony, make sure to choose the package with Symfony support (aka bundle) if available.
90-
91-
:::note
92-
93-
📣  Vagrant users might encounter some issues with Composer.
94-
A workaround solution is to add the flag `--prefer-source` to your Composer command.
95-
96-
:::
72+
```

docs/docs/03_API/3_Composer.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Composer
3+
slug: /api/composer
4+
---
5+
6+
:::note
7+
8+
📣  All commands have to be run in the `api` service (`make api`).
9+
10+
:::
11+
12+
When installing a PHP dependency, ask yourself if it is a `dev` dependency or not:
13+
14+
```
15+
composer require [--dev] [package]
16+
COMPOSER_MEMORY_LIMIT=-1 composer normalize
17+
```
18+
19+
As we're using Symfony, make sure to choose the package with Symfony support (aka bundle) if available.
20+
21+
:::note
22+
23+
📣  Vagrant users might encounter some issues with Composer.
24+
A workaround solution is to add the flag `--prefer-source` to your Composer command.
25+
26+
:::
File renamed without changes.

docs/docs/4_Web Application/4_1_Overview.md renamed to docs/docs/04_Web Application/1_Overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Overview
3-
slug: /webapp/overview
3+
slug: /webapp
44
---
55

66
We built the web application with [Nuxt.js](https://nuxtjs.org).

0 commit comments

Comments
 (0)