From ef37adb7b27eabe6397fa8762327c6a15393283c Mon Sep 17 00:00:00 2001 From: LE MONIES DE SAGAZAN Mayeul Date: Fri, 26 Apr 2024 10:29:25 +0200 Subject: [PATCH] fix: docs --- docs/content/_index.md | 4 ++-- docs/content/docs/configuration/_index.md | 2 +- docs/content/docs/installation/_index.md | 23 +++++++++++++++++++++-- 3 files changed, 24 insertions(+), 5 deletions(-) diff --git a/docs/content/_index.md b/docs/content/_index.md index 8a3a2c5..8105730 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -22,9 +22,9 @@ You can think of it like **Shadcn** but for Adonis backoffice. {{< br >}} -Adomin is for developers that are ready to **OWN** the code that they will download. +Adomin is meant to be used as a base for a quick and solid backoffice with the ability to add infinite customisations. -It is meant to be used as a base for a quick and solid backoffice with the ability to add infinite customisations. +It is for developers that are ready to **own** the code that they will copy paste. We won't be able to provide support for every bug or new feature that you might want. diff --git a/docs/content/docs/configuration/_index.md b/docs/content/docs/configuration/_index.md index b5df898..7815c88 100644 --- a/docs/content/docs/configuration/_index.md +++ b/docs/content/docs/configuration/_index.md @@ -5,4 +5,4 @@ title: 'Configuration' # Configuration -Ceci est la configuration +**this page will land soon™** diff --git a/docs/content/docs/installation/_index.md b/docs/content/docs/installation/_index.md index db6f5e2..d156b3a 100644 --- a/docs/content/docs/installation/_index.md +++ b/docs/content/docs/installation/_index.md @@ -20,5 +20,24 @@ yarn add xlsx @adonisjs/validator Adomin use imports starting with `#adomin` so you will have to configure this: -- edit `package.json` and add `"#adomin/_": "./app/adomin/_.js"` inside the `"imports"` object -- edit `tsconfig.json` and add `"#adomin/_": ["./app/adomin/_.js"]` inside the `"paths"` object +- edit `package.json` and add + +```ts +"#adomin/*": "./app/adomin/*.js" +``` + +inside the `"imports"` object + +- edit `tsconfig.json` and add + +```ts +"#adomin/*": ["./app/adomin/*.js"] +``` + +inside the `"paths"` object + +- edit `start/routes.ts` : add this import statement to enable all of Adomin routes + +```ts +import '#adomin/routes/adomin_router' +```