Feat v2/documentation

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/docs/01_getting-started/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Getting Started",
+  "position": 1
+}

docs/docs/01_getting-started/install.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 1
+---
+# Create your project
+
+## Initialize your project with the boilerplate's code base
+
+1. From and existing git repo (should be empty at that time), register boilerplate's remote
+```bash title="terminal"
+git remote add boilerplate https://github.com/thecodingmachine/symfony-boilerplate.git
+```
+
+2. Pull the source code from a release to your current branch
+```bash title="terminal"
+git pull boilerplate v2
+```
+:::tip
+Keep this remote if you want to stay up to date with new versions !
+:::
+
+## Customize with your project's specifics
+Now it's time to adapt the boilerplate to your project...
+
+**1. Set your app's name**
+
+At least you'll want to update the `APP_NAME` variable in the `.env.dist` file to match your project's name (EG. my-awsome-app).
+
+**2. Update README.md**
+
+You might want to update the README file, to describe your app's purpose, and define the coding standards you want to define.
+
+## Push the initial codebase
+
+Now you can push the boilerplate's code and start implementing !
+
+```bash title="terminal"
+git commit -am "Initial commit of the boilerplate's code base"
+git push origin main
+```

docs/docs/01_getting-started/overview.md

@@ -0,0 +1 @@
+# Overview

docs/docs/02_docker-compose.md

@@ -0,0 +1,4 @@
+---
+sidebar_position: 2
+---
+# Development environment