Doc - style and wording (#80)

* doc - style and wording * doc - wording * doc - wording
makinacorpus · Feb 12, 2024 · a7690c9 · a7690c9
1 parent 3bc5629
commit a7690c9
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -4,7 +4,7 @@ import { defineConfig } from 'vitepress'
 export default defineConfig({
   lang: 'en',
   title: 'DbToolsBundle',
-  description: 'a set of Symfony Console Commands to interact with your database',
+  description: 'A Symfony bundle to backup, restore and anonymize your data',
   srcDir: "content",
   base: "/",
   metaChunk: false,

diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
@@ -19,6 +19,7 @@
 
 .dark {
   --vp-c-brand: #bec931;
+  --vp-c-brand-1: #bec931;
   --vp-c-brand-2: #bec931;
   --vp-c-green-light: #ced65c;
   --vp-c-brand-light: #ced65c;

diff --git a/docs/content/getting-started/basics.md b/docs/content/getting-started/basics.md
@@ -89,16 +89,15 @@ class User
 ```
 
 With the above configuration, after you used `console db-tools:anonymize` on a backup file,
-all your user's email addresses will be gone and replaced with hashed ones.
+all the user email addresses it contains will be replaced with hashed ones.
 
 ::: tip
 Learn more about how to configure Anonymization in the [dedicated section](../anonymization/essentials).
 :::
 
-You can't directly run the anonymization on your local machine as to follow GDPR recommendations,
-sensitive data should never transit on an unsecured environment.
-
-We will therefore use the preproduction environment to perform anonymization.
+According to GDPR recommendations, sensitive data should never transit on an unsecured environment.
+Then, running the anonymization on our local development environment might not be compliant.
+We should therefore, for example, perform this task on the preproduction environment.
 
 ```sh
 console db-tools:anonymize path/to/my_backup.dump

diff --git a/docs/content/index.md b/docs/content/index.md
@@ -3,7 +3,7 @@ layout: home
 
 hero:
   name: DbToolsBundle
-  text: A set of Symfony Console Commands to interact with your database
+  text: Backup, restore and anonymize your data
   image:
     light: ./logo.svg
     dark: ./logo-d.svg